Crate proc_macro
1.15.0 · source ·Expand description
A support library for macro authors when defining new macros.
This library, provided by the standard distribution, provides the types
consumed in the interfaces of procedurally defined macro definitions such as
function-like macros #[proc_macro]
, macro attributes #[proc_macro_attribute]
and
custom derive attributes#[proc_macro_derive]
.
See the book for more.
Modules§
- Public implementation details for the
TokenStream
type, such as iterators. - tracked_envExperimentalTracked access to environment variables.
- tracked_pathExperimentalTracked access to additional files.
Macros§
- quoteExperimental
quote!(..)
accepts arbitrary tokens and expands into aTokenStream
describing the input. For example,quote!(a + b)
will produce an expression, that, when evaluated, constructs theTokenStream
[Ident("a"), Punct('+', Alone), Ident("b")]
.
Structs§
- A delimited token stream.
- An identifier (
ident
). - Error returned from
TokenStream::from_str
. - A literal string (
"hello"
), byte string (b"hello"
), character ('a'
), byte character (b'a'
), an integer or floating point number with or without a suffix (1
,1u8
,2.3
,2.3f32
). Boolean literals liketrue
andfalse
do not belong here, they areIdent
s. - A
Punct
is a single punctuation character such as+
,-
or#
. - A region of source code, along with macro expansion information.
- The main type provided by this crate, representing an abstract stream of tokens, or, more specifically, a sequence of token trees. The type provide interfaces for iterating over those token trees and, conversely, collecting a number of token trees into one stream.
- DiagnosticExperimentalA structure representing a diagnostic message and associated children messages.
- ExpandErrorExperimentalError returned from
TokenStream::expand_expr
. - SourceFileExperimentalThe source file of a given
Span
.
Enums§
- Describes how a sequence of token trees is delimited.
- Indicates whether a
Punct
token can join with the following token to form a multi-character operator. - A single token or a delimited sequence of token trees (e.g.,
[1, (), ..]
). - LevelExperimentalAn enum representing a diagnostic level.
Traits§
- MultiSpanExperimentalTrait implemented by types that can be converted into a set of
Span
s.
Functions§
- Determines whether proc_macro has been made accessible to the currently running program.
- quoteExperimentalQuote a
TokenStream
into aTokenStream
. This is the actual implementation of thequote!()
proc macro. - quote_spanExperimentalQuote a
Span
into aTokenStream
. This is needed to implement a custom quoter.