|
|
|
|
|
<!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 `TokenStreamExt` trait in crate `quote`."><meta name="keywords" content="rust, rustlang, rust-lang, TokenStreamExt"><title>quote::TokenStreamExt - 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 TokenStreamExt</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.append">append</a><a href="#tymethod.append_all">append_all</a><a href="#tymethod.append_separated">append_separated</a><a href="#tymethod.append_terminated">append_terminated</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-TokenStreamExt-for-TokenStream">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: 'TokenStreamExt', 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 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/ext.rs.html#10-59' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>quote</a>::<wbr><a class="trait" href=''>TokenStreamExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait TokenStreamExt: Sealed {
|
|
|
|
|
|
fn <a href='#tymethod.append' class='fnname'>append</a><U>(&mut self, token: U)<br> <span class="where">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a>></span>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.append_all' class='fnname'>append_all</a><T, I>(&mut self, iter: I)<br> <span class="where">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T></span>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.append_separated' class='fnname'>append_separated</a><T, I, U>(&mut self, iter: I, op: U)<br> <span class="where">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.append_terminated' class='fnname'>append_terminated</a><T, I, U>(&mut self, iter: I, term: U)<br> <span class="where">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>TokenStream extension trait with methods for appending tokens.</p>
|
|
|
|
|
|
<p>This trait is sealed and cannot be implemented outside of the <code>quote</code> crate.</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.append' class='method'><code id='append.v'>fn <a href='#tymethod.append' class='fnname'>append</a><U>(&mut self, token: U) <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a>>, </span></code></h3><div class='docblock'><p>For use by <code>ToTokens</code> implementations.</p>
|
|
|
|
|
|
<p>Appends the token specified to this list of tokens.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.append_all' class='method'><code id='append_all.v'>fn <a href='#tymethod.append_all' class='fnname'>append_all</a><T, I>(&mut self, iter: I) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>, </span></code></h3><div class='docblock'><p>For use by <code>ToTokens</code> implementations.</p>
|
|
|
|
|
|
<pre><code class="language-edition2018"># use quote::{quote, TokenStreamExt, ToTokens};
|
|
|
|
|
|
# use proc_macro2::TokenStream;
|
|
|
|
|
|
#
|
|
|
|
|
|
struct X;
|
|
|
|
|
|
|
|
|
|
|
|
impl ToTokens for X {
|
|
|
|
|
|
fn to_tokens(&self, tokens: &mut TokenStream) {
|
|
|
|
|
|
tokens.append_all(&[true, false]);
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
let tokens = quote!(#X);
|
|
|
|
|
|
assert_eq!(tokens.to_string(), "true false");
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
</div><h3 id='tymethod.append_separated' class='method'><code id='append_separated.v'>fn <a href='#tymethod.append_separated' class='fnname'>append_separated</a><T, I, U>(&mut self, iter: I, op: U) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></code></h3><div class='docblock'><p>For use by <code>ToTokens</code> implementations.</p>
|
|
|
|
|
|
<p>Appends all of the items in the iterator <code>I</code>, separated by the tokens
|
|
|
|
|
|
<code>U</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.append_terminated' class='method'><code id='append_terminated.v'>fn <a href='#tymethod.append_terminated' class='fnname'>append_terminated</a><T, I, U>(&mut self, iter: I, term: U) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></code></h3><div class='docblock'><p>For use by <code>ToTokens</code> implementations.</p>
|
|
|
|
|
|
<p>Appends all tokens in the iterator <code>I</code>, appending <code>U</code> after each
|
|
|
|
|
|
element, including after the last element of the iterator.</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-TokenStreamExt-for-TokenStream' class='impl'><code class='in-band'>impl <a class="trait" href="../quote/trait.TokenStreamExt.html" title="trait quote::TokenStreamExt">TokenStreamExt</a> for <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code><a href='#impl-TokenStreamExt-for-TokenStream' class='anchor'></a><a class='srclink' href='../src/quote/ext.rs.html#61-104' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.append' class="method hidden"><code id='append.v-1'>fn <a href='#method.append' class='fnname'>append</a><U>(&mut self, token: U) <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a>>, </span></code><a class='srclink' href='../src/quote/ext.rs.html#62-67' title='goto source code'>[src]</a></h4><h4 id='method.append_all' class="method hidden"><code id='append_all.v-1'>fn <a href='#method.append_all' class='fnname'>append_all</a><T, I>(&mut self, iter: I) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>, </span></code><a class='srclink' href='../src/quote/ext.rs.html#69-77' title='goto source code'>[src]</a></h4><h4 id='method.append_separated' class="method hidden"><code id='append_separated.v-1'>fn <a href='#method.append_separated' class='fnname'>append_separated</a><T, I, U>(&mut self, iter: I, op: U) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></code><a class='srclink' href='../src/quote/ext.rs.html#79-91' title='goto source code'>[src]</a></h4><h4 id='method.append_terminated' class="method hidden"><code id='append_terminated.v-1'>fn <a href='#method.append_terminated' class='fnname'>append_terminated</a><T, I, U>(&mut self, iter: I, term: U) <span class="where fmt-newline">where<br> T: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>,<br> U: <a class="trait" href="../quote/trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></code><a class='srclink' href='../src/quote/ext.rs.html#93-103' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<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.TokenStreamExt.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>
|
