mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-27 20:39:33 +01:00
44 lines
42 KiB
HTML
44 lines
42 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="Types that can be interpolated inside a `quote!` invocation."><title>ToTokens in quote - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../quote/index.html">quote</a><span class="version">1.0.37</span></h2></div><h2 class="location"><a href="#">ToTokens</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.to_tokens">to_tokens</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.into_token_stream">into_token_stream</a></li><li><a href="#method.to_token_stream">to_token_stream</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ToTokens-for-%26T">&'a T</a></li><li><a href="#impl-ToTokens-for-%26mut+T">&'a mut T</a></li><li><a href="#impl-ToTokens-for-Box%3CT%3E">Box<T></a></li><li><a href="#impl-ToTokens-for-CStr">CStr</a></li><li><a href="#impl-ToTokens-for-CString">CString</a></li><li><a href="#impl-ToTokens-for-Cow%3C'a,+T%3E">Cow<'a, T></a></li><li><a href="#impl-ToTokens-for-Group">Group</a></li><li><a href="#impl-ToTokens-for-Ident">Ident</a></li><li><a href="#impl-ToTokens-for-Literal">Literal</a></li><li><a href="#impl-ToTokens-for-Option%3CT%3E">Option<T></a></li><li><a href="#impl-ToTokens-for-Punct">Punct</a></li><li><a href="#impl-ToTokens-for-Rc%3CT%3E">Rc<T></a></li><li><a href="#impl-ToTokens-for-String">String</a></li><li><a href="#impl-ToTokens-for-TokenStream">TokenStream</a></li><li><a href="#impl-ToTokens-for-TokenTree">TokenTree</a></li><li><a href="#impl-ToTokens-for-bool">bool</a></li><li><a href="#impl-ToTokens-for-char">char</a></li><li><a href="#impl-ToTokens-for-f32">f32</a></li><li><a href="#impl-ToTokens-for-f64">f64</a></li><li><a href="#impl-ToTokens-for-i128">i128</a></li><li><a href="#impl-ToTokens-for-i16">i16</a></li><li><a href="#impl-ToTokens-for-i32">i32</a></li><li><a href="#impl-ToTokens-for-i64">i64</a></li><li><a href="#impl-ToTokens-for-i8">i8</a></li><li><a href="#impl-ToTokens-for-isize">isize</a></li><li><a href="#impl-ToTokens-for-str">str</a></li><li><a href="#im
|
||
|
|
// Required method
|
||
|
|
fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>);
|
||
|
|
|
||
|
|
// Provided methods
|
||
|
|
fn <a href="#method.to_token_stream" class="fn">to_token_stream</a>(&self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a> { ... }
|
||
|
|
<span class="item-spacer"></span> fn <a href="#method.into_token_stream" class="fn">into_token_stream</a>(self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>
|
||
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types that can be interpolated inside a <code>quote!</code> invocation.</p>
|
||
|
|
</div></details><h2 id="required-methods" class="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.to_tokens" class="method"><a class="src rightside" href="../src/quote/to_tokens.rs.html#54">source</a><h4 class="code-header">fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></summary><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>
|
||
|
|
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
|
|
<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"><code><span class="kw">use </span>proc_macro2::{TokenTree, Spacing, Span, Punct, TokenStream};
|
||
|
|
<span class="kw">use </span>quote::{TokenStreamExt, ToTokens};
|
||
|
|
|
||
|
|
<span class="kw">pub struct </span>Path {
|
||
|
|
<span class="kw">pub </span>global: bool,
|
||
|
|
<span class="kw">pub </span>segments: Vec<PathSegment>,
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">impl </span>ToTokens <span class="kw">for </span>Path {
|
||
|
|
<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) {
|
||
|
|
<span class="kw">for </span>(i, segment) <span class="kw">in </span><span class="self">self</span>.segments.iter().enumerate() {
|
||
|
|
<span class="kw">if </span>i > <span class="number">0 </span>|| <span class="self">self</span>.global {
|
||
|
|
<span class="comment">// Double colon `::`
|
||
|
|
</span>tokens.append(Punct::new(<span class="string">':'</span>, Spacing::Joint));
|
||
|
|
tokens.append(Punct::new(<span class="string">':'</span>, Spacing::Alone));
|
||
|
|
}
|
||
|
|
segment.to_tokens(tokens);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}</code></pre></div>
|
||
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.to_token_stream" class="method"><a class="src rightside" href="../src/quote/to_tokens.rs.html#60-64">source</a><h4 class="code-header">fn <a href="#method.to_token_stream" class="fn">to_token_stream</a>(&self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></h4></section></summary><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></details><details class="toggle method-toggle" open><summary><section id="method.into_token_stream" class="method"><a class="src rightside" href="../src/quote/to_tokens.rs.html#70-75">source</a><h4 class="code-header">fn <a href="#method.into_token_stream" class="fn">into_token_stream</a>(self) -> <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a><div class="where">where
|
||
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><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></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ToTokens-for-TokenTree" class="impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#261-265">source</a><a href="#impl-ToTokens-for-TokenTree" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a></h3></section></summary><div class="impl-items"><section id="method.to_tokens" class="method trait-impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#262-264">source</a><a href="#method.to_tokens" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToTokens-for-bool" class="impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#218-223">source</a><a href="#impl-ToTokens-for-bool" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.bool.html">bool</a></h3></section></summary><div class="impl-items"><section id="method.to_tokens-1" class="method trait-impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#219-222">source</a><a href="#method.to_tokens-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToTokens-for-char" class="impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#212-216">source</a><a href="#impl-ToTokens-for-char" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.char.html">char</a></h3></section></summary><div class="impl-items"><section id="method.to_tokens-2" class="method trait-impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#213-215">source</a><a href="#method.to_tokens-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToTokens-for-f32" class="impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#200-204">source</a><a href="#impl-ToTokens-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ToTokens.html" title="trait quote::ToTokens">ToTokens</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.to_tokens-3" class="method trait-impl"><a class="src rightside" href="../src/quote/to_tokens.rs.html#201-203">source</a><a href="#method.to_tokens-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.to_tokens" class="fn">to_tokens</a>(&self, tokens: &mut <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToTokens-for-f64" class="impl"><a class="src
|