45 lines
38 KiB
HTML
45 lines
38 KiB
HTML
|
<!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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
|||
|
|
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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 rust-logo'><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><a href="#method.to_token_stream">to_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-i128">i128</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-u128">u128</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!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
|||
|
|
<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 id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/quote/to_tokens.rs.html#12-77" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">quote</a>::<wbr><a class="trait" href="">ToTokens</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait ToTokens {
|
|||
|
|
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.to_token_stream" class="fnname">to_token_stream</a>(&self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> { ... }
|
|||
|
|
<div class="item-spacer"></div> 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 <code>quote!</code> 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>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>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">proc_macro2</span>::{<span class="ident">TokenTree</span>, <span class="ident">Spacing</span>, <span class="ident">Span</span>, <span class="ident">Punct</span>, <span class="ident">TokenStream</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">quote</span>::{<span class="ident">TokenStreamExt</span>, <span class="ident">ToTokens</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Path</span> {
|
|||
|
|
<span class="kw">pub</span> <span class="ident">global</span>: <span class="ident">bool</span>,
|
|||
|
|
<span class="kw">pub</span> <span class="ident">segments</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">PathSegment</span><span class="op">></span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span> <span class="ident">ToTokens</span> <span class="kw">for</span> <span class="ident">Path</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">to_tokens</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">tokens</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">TokenStream</span>) {
|
|||
|
|
<span class="kw">for</span> (<span class="ident">i</span>, <span class="ident">segment</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">segments</span>.<span class="ident">iter</span>().<span class="ident">enumerate</span>() {
|
|||
|
|
<span class="kw">if</span> <span class="ident">i</span> <span class="op">></span> <span class="number">0</span> <span class="op">|</span><span class="op">|</span> <span class="self">self</span>.<span class="ident">global</span> {
|
|||
|
|
<span class="comment">// Double colon `::`</span>
|
|||
|
|
<span class="ident">tokens</span>.<span class="ident">append</span>(<span class="ident">Punct</span>::<span class="ident">new</span>(<span class="string">':'</span>, <span class="ident">Spacing</span>::<span class="ident">Joint</span>));
|
|||
|
|
<span class="ident">tokens</span>.<span class="ident">append</span>(<span class="ident">Punct</span>::<span class="ident">new</span>(<span class="string">':'</span>, <span class="ident">Spacing</span>::<span class="ident">Alone</span>));
|
|||
|
|
}
|
|||
|
|
<span class="ident">segment</span>.<span class="ident">to_tokens</span>(<span class="ident">tokens</span>);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}</pre></div>
|
|||
|
|
</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.to_token_stream" class="method"><code>fn <a href="#method.to_token_stream" class="fnname">to_token_stream</a>(&self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></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><h3 id="method.into_token_stream" class="method"><code>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#79-83" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.to_tokens" class="method hidden"><code>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#80-82" 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#85-89" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.to_tokens-1" class="method hidden"><code>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#86-88" 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#91-95" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.to_tokens-2" class="method hidden"><code>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#92-94" 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" ti
|