proc_macro::TokenTree - Rust
Description: API documentation for the Rust `TokenTree` enum in crate `proc_macro`.
Keywords: rust, rustlang, rust-lang, TokenTree

# Enum proc_macro::TokenTree 1.29.0[−][src]

    pub enum TokenTree {
        Group(Group),
        Ident(Ident),
        Punct(Punct),
        Literal(Literal),
    }

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

## Variants

`Group(Group)`

A token stream surrounded by bracket delimiters.

`Ident(Ident)`

An identifier.

`Punct(Punct)`

A single punctuation character (`+`, `,`, `$`, etc.).

`Literal(Literal)`

A literal character (`'a'`), string (`"hello"`), number (`2.3`), etc.

## Methods

###

`impl TokenTree`

[src]

####

`pub fn span(&self) -> Span`

[src]

Returns the span of this tree, delegating to the `span` method of the contained token or a delimited stream.

####

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

[src]

Configures the span for only this token.

Note that if this token is a `Group` then this method will not configure the span of each of the internal tokens, this will simply delegate to the `set_span` method of each variant.

## Trait Implementations

###

`impl From<TokenTree> for TokenStream`

[src]

Creates a token stream containing a single token tree.

####

`fn from(tree: TokenTree) -> TokenStream`

[src]

Performs the conversion.

###

`impl FromIterator<TokenTree> for TokenStream`

[src]

Collects a number of token trees into a single stream.

####

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

[src]

Creates a value from an iterator. Read more

###

`impl Clone for TokenTree`

[src]

####

`fn clone(&self) -> TokenTree`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl !Send for TokenTree`

[src]

###

`impl !Sync for TokenTree`

[src]

###

`impl Debug for TokenTree`

[src]

Prints token treee in a form convenient for debugging.

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl From<Group> for TokenTree`

[src]

####

`fn from(g: Group) -> TokenTree`

[src]

Performs the conversion.

###

`impl From<Ident> for TokenTree`

[src]

####

`fn from(g: Ident) -> TokenTree`

[src]

Performs the conversion.

###

`impl From<Punct> for TokenTree`

[src]

####

`fn from(g: Punct) -> TokenTree`

[src]

Performs the conversion.

###

`impl From<Literal> for TokenTree`

[src]

####

`fn from(g: Literal) -> TokenTree`

[src]

Performs the conversion.

###

`impl Display for TokenTree`

[src]

Prints the token tree as a string that is supposed to be losslessly convertible back into the same token tree (modulo spans), except for possibly `TokenTree::Group`s with `Delimiter::None` delimiters and negative numeric literals.

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)