Enum TokenTreeWithMetadata 

pub enum TokenTreeWithMetadata<G, I = G, P = G, L = I> {
    Group(GroupWithMetadata<G, I, P, L>),
    Ident(TokenWithMetadata<Ident, I>),
    Punct(TokenWithMetadata<Punct, P>),
    Literal(TokenWithMetadata<Literal, L>),
}

A version of TokenTree with arbitrary attached metadata.

Each variant holds metadata of a different type. The types are:

• G: For GroupWithMetadatas (in proc_macro2, Groups).
• I: For Ident tokens (defaults to the same type as G).
• P: For Punct tokens (defaults to the same type as G).
• L: For Literal tokens (defaults to the same type as I).

See proc_macro2’s documentation for more information.

Variants

Group(GroupWithMetadata<G, I, P, L>)

A GroupWithMetadata token with its corresponding metadata. The tokens within the group, correspondingly, also have metadata, with the same types.

Ident(TokenWithMetadata<Ident, I>)

An Ident token with its corresponding metadata.

Punct(TokenWithMetadata<Punct, P>)

A Punct token with its corresponding metadata.

Literal(TokenWithMetadata<Literal, L>)

A Literal token with its corresponding metadata.

Implementations

impl<G, I, P, L> TokenTreeWithMetadata<G, I, P, L>

pub fn strip_metadata(self) -> TokenTree

Strips the metadata from this TokenTreeWithMetadata, returning an ordinary TokenTree. Child GroupWithMetadatas will also be stripped of their metadata.

pub fn span(&self) -> Span

Gets the span of this token.

See TokenTree::span.

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

Sets the span of this token.

See TokenTree::set_span.

impl<T> TokenTreeWithMetadata<T>

pub fn get_metadata(self) -> T

Consumes self and returns the metadata associated with this token. Only available when all metadata types are the same.

pub fn get_metadata_ref(&self) -> &T

Returns a reference to the metadata associated with this token. Only available when all metadata types are the same.

pub fn get_metadata_mut(&mut self) -> &mut T

Returns a mutable reference to the metadata associated with this token. Only available when all metadata types are the same.

pub fn set_metadata(&mut self, metadata: T)

Sets the metadata associated with this token. Only available when all metadata types are the same.

Trait Implementations

impl<G: Clone, I: Clone, P: Clone, L: Clone> Clone for TokenTreeWithMetadata<G, I, P, L>

fn clone(&self) -> TokenTreeWithMetadata<G, I, P, L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<G: Debug, I: Debug, P: Debug, L: Debug> Debug for TokenTreeWithMetadata<G, I, P, L>

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

Formats the value using the given formatter.

impl<G, I, P, L> From<(Group, &G, &I, &P, &L)> for TokenTreeWithMetadata<G, I, P, L>

where G: Clone, I: Clone, P: Clone, L: Clone,

fn from(group_and_vals: (Group, &G, &I, &P, &L)) -> Self

Converts to this type from the input type.

impl<T> From<(Group, &T)> for TokenTreeWithMetadata<T>

where T: Clone,

fn from(group_and_val: (Group, &T)) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<(Ident, I)> for TokenTreeWithMetadata<G, I, P, L>

fn from((ident, metadata): (Ident, I)) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<(Literal, L)> for TokenTreeWithMetadata<G, I, P, L>

fn from((literal, metadata): (Literal, L)) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<(Punct, P)> for TokenTreeWithMetadata<G, I, P, L>

fn from((punct, metadata): (Punct, P)) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<(TokenTree, &G, &I, &P, &L)> for TokenTreeWithMetadata<G, I, P, L>

where G: Clone, I: Clone, P: Clone, L: Clone,

fn from((tree, g, i, p, l): (TokenTree, &G, &I, &P, &L)) -> Self

Converts to this type from the input type.

impl<T> From<(TokenTree, &T)> for TokenTreeWithMetadata<T>

where T: Clone,

fn from((tree, metadata): (TokenTree, &T)) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<Group> for TokenTreeWithMetadata<G, I, P, L>

where G: Default, I: Default, P: Default, L: Default,

fn from(group: Group) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<Ident> for TokenTreeWithMetadata<G, I, P, L>

where I: Default,

fn from(ident: Ident) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<Literal> for TokenTreeWithMetadata<G, I, P, L>

where L: Default,

fn from(literal: Literal) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<Punct> for TokenTreeWithMetadata<G, I, P, L>

where P: Default,

fn from(punct: Punct) -> Self

Converts to this type from the input type.

impl<G, I, P, L> From<TokenTree> for TokenTreeWithMetadata<G, I, P, L>

where G: Default, I: Default, P: Default, L: Default,

fn from(tree: TokenTree) -> Self

Converts to this type from the input type.