Struct proc_macro::TokenStream

[+] Show type declaration

pub struct TokenStream(_);

[−] Expand description

The main type provided by this crate, representing an abstract stream of tokens.

This is both the input and output of #[proc_macro_derive] definitions. Currently it's required to be a list of valid Rust items, but this restriction may be lifted in the future.

The API of this type is intentionally bare-bones, but it'll be expanded over time!

Methods

impl TokenStream

[−]

pub fn empty() -> TokenStream

[−]

🔬 This is a nightly-only experimental API. (proc_macro #38356)

Returns an empty TokenStream.

pub fn is_empty(&self) -> bool

[−]

🔬 This is a nightly-only experimental API. (proc_macro #38356)

Checks if this TokenStream is empty.

Trait Implementations

impl Clone for TokenStream

[+]

fn clone(&self) -> TokenStream

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Debug for TokenStream

[+]

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

[−]

Formats the value using the given formatter.

impl FromStr for TokenStream

[+]

type Err = LexError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<TokenStream, LexError>

[−]

Parses a string s to return a value of this type.

impl Display for TokenStream

[+]

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

[−]

Formats the value using the given formatter.

impl From<TokenTree> for TokenStream

[+]

fn from(tree: TokenTree) -> TokenStream

[−]

Performs the conversion.

impl From<TokenNode> for TokenStream

[+]

fn from(kind: TokenNode) -> TokenStream

[−]

Performs the conversion.

impl<T: Into<TokenStream>> FromIterator<T> for TokenStream

[+]

fn from_iter<I: IntoIterator<Item = T>>(streams: I) -> Self

[−]

Creates a value from an iterator.

impl IntoIterator for TokenStream

[+]

type Item = TokenTree

The type of the elements being iterated over.

type IntoIter = TokenTreeIter

Which kind of iterator are we turning this into?

Important traits for TokenTreeIter

impl Iterator for TokenTreeIter type Item = TokenTree;

fn into_iter(self) -> TokenTreeIter

[−]

Creates an iterator from a value.