pub enum TokenTree {
    Token(Token, Spacing),
    Delimited(DelimSpan, Delimiter, TokenStream),
}
Expand description

When the main Rust parser encounters a syntax-extension invocation, it parses the arguments to the invocation as a token tree. This is a very loose structure, such that all sorts of different AST fragments can be passed to syntax extensions using a uniform type.

If the syntax extension is an MBE macro, it will attempt to match its LHS token tree against the provided token tree, and if it finds a match, will transcribe the RHS token tree, splicing in any captured macro_parser::matched_nonterminals into the SubstNts it finds.

The RHS of an MBE macro is the only place SubstNts are substituted. Nothing special happens to misnamed or misplaced SubstNts.

Variants§

§

Token(Token, Spacing)

A single token. Should never be OpenDelim or CloseDelim, because delimiters are implicitly represented by Delimited.

§

Delimited(DelimSpan, Delimiter, TokenStream)

A delimited sequence of token trees.

Implementations§

source§

impl TokenTree

source

pub fn eq_unspanned(&self, other: &TokenTree) -> bool

Checks if this TokenTree is equal to the other, regardless of span information.

source

pub fn span(&self) -> Span

Retrieves the TokenTree’s span.

source

pub fn set_span(&mut self, span: Span)

Modify the TokenTree’s span in-place.

source

pub fn token_alone(kind: TokenKind, span: Span) -> TokenTree

Create a TokenTree::Token with alone spacing.

source

pub fn token_joint(kind: TokenKind, span: Span) -> TokenTree

Create a TokenTree::Token with joint spacing.

source

pub fn uninterpolate(&self) -> Cow<'_, TokenTree>

Trait Implementations§

source§

impl Clone for TokenTree

source§

fn clone(&self) -> TokenTree

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for TokenTree

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<__D: Decoder> Decodable<__D> for TokenTree

source§

fn decode(__decoder: &mut __D) -> Self

source§

impl<__E: Encoder> Encodable<__E> for TokenTree

source§

fn encode(&self, __encoder: &mut __E)

source§

impl FromIterator<TokenTree> for TokenStream

source§

fn from_iter<I: IntoIterator<Item = TokenTree>>(iter: I) -> Self

Creates a value from an iterator. Read more
source§

impl<__CTX> HashStable<__CTX> for TokenTreewhere __CTX: HashStableContext,

source§

fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

source§

impl PartialEq<TokenTree> for TokenTree

source§

fn eq(&self, other: &TokenTree) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for TokenTree

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes

Size for each variant:

  • Token: 31 bytes
  • Delimited: 31 bytes