Trait ToTokens 

pub trait ToTokens {
    // Required method
    fn to_tokens(&self, tokens: &mut TokenStream);

    // Provided methods
    fn to_token_stream(&self) -> TokenStream { ... }
    fn into_token_stream(self) -> TokenStream
       where Self: Sized { ... }
}

Types that can be interpolated inside a quote! invocation.

Required Methods

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

The token append methods provided by the TokenStreamExt extension trait may be useful for implementing ToTokens.

Example

Example implementation for a struct representing Rust paths like std::cmp::PartialEq:

use proc_macro2::{TokenTree, Spacing, Span, Punct, TokenStream};
use quote::{TokenStreamExt, ToTokens};

pub struct Path {
    pub global: bool,
    pub segments: Vec<PathSegment>,
}

impl ToTokens for Path {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        for (i, segment) in self.segments.iter().enumerate() {
            if i > 0 || self.global {
                // Double colon `::`
                tokens.append(Punct::new(':', Spacing::Joint));
                tokens.append(Punct::new(':', Spacing::Alone));
            }
            segment.to_tokens(tokens);
        }
    }
}

Provided Methods

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

This method is implicitly implemented using to_tokens, and acts as a convenience method for consumers of the ToTokens trait.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

This method is implicitly implemented using to_tokens, and acts as a convenience method for consumers of the ToTokens trait.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl ToTokens for Abstract

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for And

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for AndAnd

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for AndEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for As

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Async

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for At

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Auto

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Await

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Become

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Box

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Break

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for CStr

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for CString

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Caret

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for CaretEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Colon

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Comma

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Const

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Continue

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Crate

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Default

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Do

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Dollar

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Dot

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for DotDot

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for DotDotDot

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for DotDotEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Dyn

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Else

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Enum

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Eq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for EqEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Extern

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for FatArrow

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Final

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Fn

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for For

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Ge

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Group

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Gt

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Ident

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for If

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Impl

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for In

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LArrow

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Le

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Let

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Lifetime

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Lit

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitBool

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitByte

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitByteStr

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitCStr

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitChar

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitFloat

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitInt

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for LitStr

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Literal

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Loop

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Lt

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Macro

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Match

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Minus

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for MinusEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Mod

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Move

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Mut

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Ne

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Not

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Nothing

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Or

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for OrEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for OrOr

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Override

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for PathSep

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Percent

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for PercentEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Plus

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for PlusEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Pound

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Priv

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Pub

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Punct

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Question

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for RArrow

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Raw

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Ref

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Return

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for SelfType

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for SelfValue

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Semi

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Shl

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for ShlEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Shr

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for ShrEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Slash

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for SlashEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Star

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for StarEq

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Static

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for String

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Struct

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Super

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Tilde

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for TokenStream

fn to_tokens(&self, tokens: &mut TokenStream)

fn into_token_stream(self) -> TokenStream

impl ToTokens for TokenTree

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Trait

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Try

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Type

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Typeof

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Underscore

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Union

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Unsafe

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Unsized

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Use

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Virtual

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Where

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for While

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for Yield

Available on crate feature printing only.

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for bool

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for char

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for f32

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for f64

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for i8

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for i16

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for i32

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for i64

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for i128

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for isize

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for str

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for u8

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for u16

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for u32

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for u64

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for u128

fn to_tokens(&self, tokens: &mut TokenStream)

impl ToTokens for usize

fn to_tokens(&self, tokens: &mut TokenStream)

impl<'a, T> ToTokens for Cow<'a, T>

where T: ToOwned + ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T, P> ToTokens for Pair<T, P>

where T: ToTokens, P: ToTokens,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T, P> ToTokens for Punctuated<T, P>

where T: ToTokens, P: ToTokens,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for &T

where T: ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for &mut T

where T: ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for Arc<T>

where T: ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for Box<T>

where T: ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for Option<T>

where T: ToTokens,

fn to_tokens(&self, tokens: &mut TokenStream)

impl<T> ToTokens for Rc<T>

where T: ToTokens + ?Sized,

fn to_tokens(&self, tokens: &mut TokenStream)

Implementors