Trait quote::ToTokens

pub trait ToTokens {
    fn to_tokens(&self, tokens: &mut 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);
        }
    }
}

Loading content...

Provided methods

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.

Loading content...

Implementations on Foreign Types

impl<'a, T: ?Sized + ToTokens> ToTokens for &'a T

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl<'a, T: ?Sized + ToTokens> ToTokens for &'a mut T

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl<'a, T: ?Sized + ToOwned + ToTokens> ToTokens for Cow<'a, T>

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl<T: ?Sized + ToTokens> ToTokens for Box<T>

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl<T: ToTokens> ToTokens for Option<T>

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for str

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for String

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for i8

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for i16

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for i32

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for i64

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for isize

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for u8

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for u16

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for u32

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for u64

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for usize

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for f32

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for f64

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for char

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for bool

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for Group

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for Ident

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for Punct

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for Literal

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for TokenTree

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

fn into_token_stream(self) -> TokenStream where
    Self: Sized, 

impl ToTokens for TokenStream

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

fn into_token_stream(self) -> TokenStream

Loading content...

Implementors

Loading content...