187 lines
64 KiB
HTML
187 lines
64 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="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
<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">&'a T</a><a href="#impl-ToTokens">Cow<'a, T></a><a href="#impl-ToTokens">Box<T></a><a href="#impl-ToTokens">Option<T></a><a href="#impl-ToTokens">str</a><a href="#impl-ToTokens">String</a><a href="#impl-ToTokens">i8</a><a href="#impl-ToTokens">i16</a><a href="#impl-ToTokens">i32</a><a href="#impl-ToTokens">i64</a><a href="#impl-ToTokens">isize</a><a href="#impl-ToTokens">u8</a><a href="#impl-ToTokens">u16</a><a href="#impl-ToTokens">u32</a><a href="#impl-ToTokens">u64</a><a href="#impl-ToTokens">usize</a><a href="#impl-ToTokens">f32</a><a href="#impl-ToTokens">f64</a><a href="#impl-ToTokens">char</a><a href="#impl-ToTokens">bool</a><a href="#impl-ToTokens">Group</a><a href="#impl-ToTokens">Ident</a><a href="#impl-ToTokens">Punct</a><a href="#impl-ToTokens">Literal</a><a href="#impl-ToTokens">TokenTree</a><a href="#impl-ToTokens">TokenStream</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">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>quote</a>::<wbr><a class="trait" href=''>ToTokens</a></span><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#10-72' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><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.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'><span id='to_tokens.v' class='invisible'><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></span></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 class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">quote</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">quote</span>::{<span class="ident">TokenStreamExt</span>, <span class="ident">ToTokens</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">proc_macro2</span>;
|
|||
|
|
<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">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="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>
|
|||
|
|
<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'><span id='into_token_stream.v' class='invisible'><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></span></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>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-ToTokens' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#74-78' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.to_tokens' class="method"><span id='to_tokens.v-1' class='invisible'><table class='table-display'><tbody><tr><td><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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#75-77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.into_token_stream-1' class="method"><span id='into_token_stream.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../quote/trait.ToTokens.html#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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#64-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-ToTokens-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>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-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#80-84' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.to_tokens-1' class="method"><span id='to_tokens.v-2' class='invisible'><table class='table-display'><tbody><tr><td><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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/quote/to_tokens.rs.html#81-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.into_token_stream-2' class="method"><span id='into_token_stream.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../quote/trait.ToTokens.html#method.into_token_stream' class='f
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
</ul><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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "quote";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|