Crate rustc_proc_macro 

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.

Re-exports

pub(crate) use core::convert::From; 🔒

pub(crate) use core::ops::BitOr; 🔒

pub(crate) use std::borrow::Cow; 🔒

pub(crate) use std::ffi::CStr; 🔒

pub(crate) use Range; 🔒

pub(crate) use RangeBounds; 🔒

pub(crate) use std::path::PathBuf; 🔒

pub(crate) use std::str::FromStr; 🔒

pub(crate) use error; 🔒

pub(crate) use fmt; 🔒

pub(crate) use MixedUnit; 🔒

pub(crate) use unescape_byte; 🔒

pub(crate) use unescape_byte_str; 🔒

pub(crate) use unescape_c_str; 🔒

pub(crate) use unescape_char; 🔒

pub(crate) use unescape_str; 🔒

pub use quote::quote;Experimental

pub use quote::quote_span;Experimental

Modules

diagnostic 🔒

escape 🔒

to_tokens 🔒

token_stream

Public implementation details for the TokenStream type, such as iterators.

trackedExperimental

Functionality for adding environment state to the build dependency info.

Macros

diagnostic_method 🔒

extend_items 🔒

float_values 🔒

integer_values 🔒

suffixed_int_literals 🔒

unsuffixed_int_literals 🔒

quoteExperimental

quote!(..) accepts arbitrary tokens and expands into a TokenStream describing the input. For example, quote!(a + b) will produce an expression, that, when evaluated, constructs the TokenStream [Ident("a"), Punct('+', Alone), Ident("b")].

Structs

ConcatStreamsHelper 🔒

Non-generic helper for implementing FromIterator<TokenStream> and Extend<TokenStream> with less monomorphization in calling crates.

ConcatTreesHelper 🔒

Non-generic helper for implementing FromIterator<TokenTree> and Extend<TokenTree> with less monomorphization in calling crates.

EscapeOptions 🔒

Group

A delimited token stream.

Ident

An identifier (ident).

LexError

Error returned from TokenStream::from_str.

Literal

A literal string ("hello"), byte string (b"hello"), C string (c"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 like true and false do not belong here, they are Idents.

Punct

A Punct is a single punctuation character such as +, - or #.

Span

A region of source code, along with macro expansion information.

TokenStream

The main type provided by this crate, representing an abstract stream of tokens, or, more specifically, a sequence of token trees. The type provides interfaces for iterating over those token trees and, conversely, collecting a number of token trees into one stream.

BridgeMethods 🔒 Experimental

DiagnosticExperimental

A structure representing a diagnostic message and associated children messages.

ExpandErrorExperimental

Error returned from TokenStream::expand_expr.

Enums

Base 🔒

Delimiter

Describes how a sequence of token trees is delimited.

Spacing

Indicates whether a Punct token can join with the following token to form a multi-character operator.

TokenTree

A single token or a delimited sequence of token trees (e.g., [1, (), ..]).

ConversionErrorKindExperimental

Errors returned when trying to retrieve a literal unescaped value.

EscapeErrorExperimental

Mostly relating to malformed escape sequences, but also a few other problems.

LevelExperimental

An enum representing a diagnostic level.

Traits

MultiSpanExperimental

Trait implemented by types that can be converted into a set of Spans.

ToTokensExperimental

Types that can be interpolated inside a quote! invocation.

Functions

escape_bytes 🔒

is_available

Determines whether proc_macro has been made accessible to the currently running program.

parse_number 🔒

strip_underscores 🔒

tree_to_bridge_tree 🔒

quoteExperimental

Quote a TokenStream into a TokenStream. This is the actual implementation of the quote!() proc macro.

quote_spanExperimental

Quote a Span into a TokenStream. This is needed to implement a custom quoter.