28 lines
18 KiB
HTML
28 lines
18 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="TokenStream extension trait with methods for appending tokens."><meta name="keywords" content="rust, rustlang, rust-lang, TokenStreamExt"><title>TokenStreamExt in quote - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../quote/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../quote/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">TokenStreamExt</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.append">append</a></li><li><a href="#tymethod.append_all">append_all</a></li><li><a href="#tymethod.append_separated">append_separated</a></li><li><a href="#tymethod.append_terminated">append_terminated</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-TokenStreamExt-for-TokenStream">TokenStream</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In quote</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../quote/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">quote</a>::<wbr><a class="trait" href="#">TokenStreamExt</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/quote/ext.rs.html#8-57">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>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/1.64.0/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>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.append_all" class="fnname">append_all</a><I>(&mut self, iter: I)<br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.append_separated" class="fnname">append_separated</a><I, U>(&mut self, iter: I, op: U)<br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.append_terminated" class="fnname">append_terminated</a><I, U>(&mut self, iter: I, term: U)<br> <span class="where">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.append" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#12-14">source</a></div><h4 class="code-header">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/1.64.0/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></h4></div></summary><div class="docblock"><p>For use by <code>ToTokens</code> implementations.</p>
|
||
<p>Appends the token specified to this list of tokens.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.append_all" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#33-36">source</a></div><h4 class="code-header">fn <a href="#tymethod.append_all" class="fnname">append_all</a><I>(&mut self, iter: I) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></div></summary><div class="docblock"><p>For use by <code>ToTokens</code> implementations.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct</span> <span class="ident">X</span>;
|
||
|
||
<span class="kw">impl</span> <span class="ident">ToTokens</span> <span class="kw">for</span> <span class="ident">X</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">&mut</span> <span class="ident">TokenStream</span>) {
|
||
<span class="ident">tokens</span>.<span class="ident">append_all</span>(<span class="kw-2">&</span>[<span class="bool-val">true</span>, <span class="bool-val">false</span>]);
|
||
}
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">tokens</span> <span class="op">=</span> <span class="macro">quote!</span>(#<span class="ident">X</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">tokens</span>.<span class="ident">to_string</span>(), <span class="string">"true false"</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.append_separated" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#42-46">source</a></div><h4 class="code-header">fn <a href="#tymethod.append_separated" class="fnname">append_separated</a><I, U>(&mut self, iter: I, op: U) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></div></summary><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></details><details class="rustdoc-toggle" open><summary><div id="tymethod.append_terminated" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#52-56">source</a></div><h4 class="code-header">fn <a href="#tymethod.append_terminated" class="fnname">append_terminated</a><I, U>(&mut self, iter: I, term: U) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></div></summary><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></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TokenStreamExt-for-TokenStream" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#59-102">source</a></span><a href="#impl-TokenStreamExt-for-TokenStream" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="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></h3></section></summary><div class="impl-items"><section id="method.append" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#60-65">source</a></span><a href="#method.append" class="anchor"></a><h4 class="code-header">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/1.64.0/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></h4></section><section id="method.append_all" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#67-75">source</a></span><a href="#method.append_all" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.append_all" class="fnname">append_all</a><I>(&mut self, iter: I) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></section><section id="method.append_separated" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#77-89">source</a></span><a href="#method.append_separated" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.append_separated" class="fnname">append_separated</a><I, U>(&mut self, iter: I, op: U) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></section><section id="method.append_terminated" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/quote/ext.rs.html#91-101">source</a></span><a href="#method.append_terminated" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.append_terminated" class="fnname">append_terminated</a><I, U>(&mut self, iter: I, term: U) <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,<br> I::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,<br> U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>, </span></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/quote/ext/trait.TokenStreamExt.js" data-ignore-extern-crates="proc_macro2" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="quote" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |