|
|
|
|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ToTokens` trait in crate `quote`."><meta name="keywords" content="rust, rustlang, rust-lang, ToTokens"><title>quote::ToTokens - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../quote/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ToTokens</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.to_tokens">to_tokens</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.into_token_stream">into_token_stream</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ToTokens-for-%26%27a%20T">&'a T</a><a href="#impl-ToTokens-for-%26%27a%20mut%20T">&'a mut T</a><a href="#impl-ToTokens-for-Box%3CT%3E">Box<T></a><a href="#impl-ToTokens-for-Cow%3C%27a%2C%20T%3E">Cow<'a, T></a><a href="#impl-ToTokens-for-Group">Group</a><a href="#impl-ToTokens-for-Ident">Ident</a><a href="#impl-ToTokens-for-Literal">Literal</a><a href="#impl-ToTokens-for-Option%3CT%3E">Option<T></a><a href="#impl-ToTokens-for-Punct">Punct</a><a href="#impl-ToTokens-for-Rc%3CT%3E">Rc<T></a><a href="#impl-ToTokens-for-String">String</a><a href="#impl-ToTokens-for-TokenStream">TokenStream</a><a href="#impl-ToTokens-for-TokenTree">TokenTree</a><a href="#impl-ToTokens-for-bool">bool</a><a href="#impl-ToTokens-for-char">char</a><a href="#impl-ToTokens-for-f32">f32</a><a href="#impl-ToTokens-for-f64">f64</a><a href="#impl-ToTokens-for-i16">i16</a><a href="#impl-ToTokens-for-i32">i32</a><a href="#impl-ToTokens-for-i64">i64</a><a href="#impl-ToTokens-for-i8">i8</a><a href="#impl-ToTokens-for-isize">isize</a><a href="#impl-ToTokens-for-str">str</a><a href="#impl-ToTokens-for-u16">u16</a><a href="#impl-ToTokens-for-u32">u32</a><a href="#impl-ToTokens-for-u64">u64</a><a href="#impl-ToTokens-for-u8">u8</a><a href="#impl-ToTokens-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>quote</a></p><script>window.sidebarCurrent = {name: 'ToTokens', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span
|
|
|
|
|
|
fn <a href='#tymethod.to_tokens' class='fnname'>to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>);
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.into_token_stream' class='fnname'>into_token_stream</a>(self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Types that can be interpolated inside a <a href="macro.quote.html"><code>quote!</code></a> invocation.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.to_tokens' class='method'><code id='to_tokens.v'>fn <a href='#tymethod.to_tokens' class='fnname'>to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</code></h3><div class='docblock'><p>Write <code>self</code> to the given <code>TokenStream</code>.</p>
|
|
|
|
|
|
<p>The token append methods provided by the <a href="trait.TokenStreamExt.html"><code>TokenStreamExt</code></a> extension
|
|
|
|
|
|
trait may be useful for implementing <code>ToTokens</code>.</p>
|
|
|
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
|
|
|
<p>Example implementation for a struct representing Rust paths like
|
|
|
|
|
|
<code>std::cmp::PartialEq</code>:</p>
|
|
|
|
|
|
<pre><code class="language-edition2018">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!()
|
|
|
|
|
|
# }
|
|
|
|
|
|
# }
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.into_token_stream' class='method'><code id='into_token_stream.v'>fn <a href='#method.into_token_stream' class='fnname'>into_token_stream</a>(self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><div class='docblock'><p>Convert <code>self</code> directly into a <code>TokenStream</code> object.</p>
|
|
|
|
|
|
<p>This method is implicitly implemented using <code>to_tokens</code>, and acts as a
|
|
|
|
|
|
convenience method for consumers of the <code>ToTokens</code> trait.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-ToTokens-for-%26%27a%20T' class='impl'><code class='in-band'>impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>> <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T</code><a href='#impl-ToTokens-for-%26%27a%20T' class='anchor'></a><a class='srclink' href='../src/quote/to_tokens.rs.html#71-75' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_tokens' class="method hidden"><code id='to_tokens.v-1'>fn <a href='#method.to_tokens' class='fnname'>to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</code><a class='srclink' href='../src/quote/to_tokens.rs.html#72-74' title='goto source code'>[src]</a></h4></div><h3 id='impl-ToTokens-for-%26%27a%20mut%20T' class='impl'><code class='in-band'>impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>> <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T</code><a href='#impl-ToTokens-for-%26%27a%20mut%20T' class='anchor'></a><a class='srclink' href='../src/quote/to_tokens.rs.html#77-81' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_tokens-1' class="method hidden"><code id='to_tokens.v-2'>fn <a href='#method.to_tokens' class='fnname'>to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</code><a class='srclink' href='../src/quote/to_tokens.rs.html#78-80' title='goto source code'>[src]</a></h4></div><h3 id='impl-ToTokens-for-Cow%3C%27a%2C%20T%3E' class='impl'><code class='in-band'>impl<'a, T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> + <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>> <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, T></code><a href='#impl-ToTokens-for-Cow%3C%27a%2C%20T%3E' class='anchor'></a><a class='srclink' href='../src/quote/to_tokens.rs.html#83-87' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_tokens-2' class="method hidden"><code id='to_tokens.v-3'>fn <a href='#method.to_tokens' class='fnname'>to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</code><a class='srclink' href='../src/quote/to_tokens.rs.html#84-86' title='goto source code'>[src]</a></h4></div><h3 id='impl-ToTokens-for-Box%3CT%3E' class='impl'><code class='in-band'>impl<T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>> <a class="trait" href="../quote/trait.ToTokens.html"
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../implementors/quote/trait.ToTokens.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "quote";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
