56 lines
No EOL
16 KiB
HTML
56 lines
No EOL
16 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."><title>TokenStreamExt in quote - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="quote" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0 (79e9716c9 2023-11-13)" data-channel="1.74.0" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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="logo-container" href="../quote/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../quote/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">TokenStreamExt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><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><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TokenStreamExt-for-TokenStream">TokenStream</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In quote</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">quote</a>::<wbr><a class="trait" href="#">TokenStreamExt</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/quote/ext.rs.html#8-57">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TokenStreamExt: Sealed {
|
||
// Required methods
|
||
fn <a href="#tymethod.append" class="fn">append</a><U>(&mut self, token: U)
|
||
<span class="where">where U: <a class="trait" href="https://doc.rust-lang.org/1.74.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="fn">append_all</a><I>(&mut self, iter: I)
|
||
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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="fn">append_separated</a><I, U>(&mut self, iter: I, op: U)
|
||
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
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="fn">append_terminated</a><I, U>(&mut self, iter: I, term: U)
|
||
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a></span>;
|
||
}</code></pre><details class="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="toggle method-toggle" open><summary><section id="tymethod.append" class="method"><a class="src rightside" href="../src/quote/ext.rs.html#12-14">source</a><h4 class="code-header">fn <a href="#tymethod.append" class="fn">append</a><U>(&mut self, token: U)<span class="where fmt-newline">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.74.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></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="toggle method-toggle" open><summary><section id="tymethod.append_all" class="method"><a class="src rightside" href="../src/quote/ext.rs.html#33-36">source</a><h4 class="code-header">fn <a href="#tymethod.append_all" class="fn">append_all</a><I>(&mut self, iter: I)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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></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>X;
|
||
|
||
<span class="kw">impl </span>ToTokens <span class="kw">for </span>X {
|
||
<span class="kw">fn </span>to_tokens(<span class="kw-2">&</span><span class="self">self</span>, tokens: <span class="kw-2">&mut </span>TokenStream) {
|
||
tokens.append_all(<span class="kw-2">&</span>[<span class="bool-val">true</span>, <span class="bool-val">false</span>]);
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>tokens = <span class="macro">quote!</span>(#X);
|
||
<span class="macro">assert_eq!</span>(tokens.to_string(), <span class="string">"true false"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.append_separated" class="method"><a class="src rightside" href="../src/quote/ext.rs.html#42-46">source</a><h4 class="code-header">fn <a href="#tymethod.append_separated" class="fn">append_separated</a><I, U>(&mut self, iter: I, op: U)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,</span></h4></section></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="toggle method-toggle" open><summary><section id="tymethod.append_terminated" class="method"><a class="src rightside" href="../src/quote/ext.rs.html#52-56">source</a><h4 class="code-header">fn <a href="#tymethod.append_terminated" class="fn">append_terminated</a><I, U>(&mut self, iter: I, term: U)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
U: <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a>,</span></h4></section></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="toggle implementors-toggle"><summary><section id="impl-TokenStreamExt-for-TokenStream" class="impl"><a class="src rightside" href="../src/quote/ext.rs.html#59-102">source</a><a href="#impl-TokenStreamExt-for-TokenStream" class="anchor">§</a><h3 class="code-header">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"><a class="src rightside" href="../src/quote/ext.rs.html#60-65">source</a><a href="#method.append" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append" class="fn">append</a><U>(&mut self, token: U)<span class="where fmt-newline">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.74.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"><a class="src rightside" href="../src/quote/ext.rs.html#67-75">source</a><a href="#method.append_all" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append_all" class="fn">append_all</a><I>(&mut self, iter: I)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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"><a class="src rightside" href="../src/quote/ext.rs.html#77-89">source</a><a href="#method.append_separated" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append_separated" class="fn">append_separated</a><I, U>(&mut self, iter: I, op: U)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
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"><a class="src rightside" href="../src/quote/ext.rs.html#91-101">source</a><a href="#method.append_terminated" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append_terminated" class="fn">append_terminated</a><I, U>(&mut self, iter: I, term: U)<span class="where fmt-newline">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.74.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.74.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>,
|
||
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 id="implementors-list"></div><script src="../implementors/quote/ext/trait.TokenStreamExt.js" data-ignore-extern-crates="proc_macro2" async></script></section></div></main></body></html> |