Trait quote::ToTokens

[+] Show declaration

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

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

[−] Expand description

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);
        }
    }
}
#
# pub struct PathSegment;
#
# impl ToTokens for PathSegment {
#     fn to_tokens(&self, tokens: &mut TokenStream) {
#         unimplemented!()
#     }
# }

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.

Implementations on Foreign Types

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

[+] Show hidden undocumented items

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[−]

[+] Show hidden undocumented items

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>[−]

[+] Show hidden undocumented items

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

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

impl<T: ?Sized + ToTokens> ToTokens for Box<T>[−]

[+] Show hidden undocumented items

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

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

impl<T: ?Sized + ToTokens> ToTokens for Rc<T>[−]

[+] Show hidden undocumented items

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

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

impl<T: ToTokens> ToTokens for Option<T>[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for str[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for String[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for i8[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for i16[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for i32[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for i64[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for isize[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for u8[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for u16[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for u32[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for u64[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for usize[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for f32[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for f64[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for char[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for bool[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for Group[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for Ident[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for Punct[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for Literal[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for TokenTree[−]

[+] Show hidden undocumented items

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

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

impl ToTokens for TokenStream[−]

[+] Show hidden undocumented items

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

fn into_token_stream(self) -> TokenStream

Implementors