blob: 8ba7f15749cf4a6b5943ee70cd52cb9205d7ad9c [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/quote-1.0.28/src/to_tokens.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>to_tokens.rs - source</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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../quote/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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"><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="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::TokenStreamExt;
<span class="kw">use </span>core::iter;
<span class="kw">use </span>proc_macro2::{Group, Ident, Literal, Punct, Span, TokenStream, TokenTree};
<span class="kw">use </span>std::borrow::Cow;
<span class="kw">use </span>std::rc::Rc;
<span class="doccomment">/// Types that can be interpolated inside a `quote!` invocation.
///
/// [`quote!`]: macro.quote.html
</span><span class="kw">pub trait </span>ToTokens {
<span class="doccomment">/// Write `self` to the given `TokenStream`.
///
/// The token append methods provided by the [`TokenStreamExt`] extension
/// trait may be useful for implementing `ToTokens`.
///
/// [`TokenStreamExt`]: trait.TokenStreamExt.html
///
/// # Example
///
/// Example implementation for a struct representing Rust paths like
/// `std::cmp::PartialEq`:
///
/// ```
/// use proc_macro2::{TokenTree, Spacing, Span, Punct, TokenStream};
/// use quote::{TokenStreamExt, ToTokens};
///
/// pub struct Path {
/// pub global: bool,
/// pub segments: Vec&lt;PathSegment&gt;,
/// }
///
/// impl ToTokens for Path {
/// fn to_tokens(&amp;self, tokens: &amp;mut TokenStream) {
/// for (i, segment) in self.segments.iter().enumerate() {
/// if i &gt; 0 || self.global {
/// // Double colon `::`
/// tokens.append(Punct::new(&#39;:&#39;, Spacing::Joint));
/// tokens.append(Punct::new(&#39;:&#39;, Spacing::Alone));
/// }
/// segment.to_tokens(tokens);
/// }
/// }
/// }
/// #
/// # pub struct PathSegment;
/// #
/// # impl ToTokens for PathSegment {
/// # fn to_tokens(&amp;self, tokens: &amp;mut TokenStream) {
/// # unimplemented!()
/// # }
/// # }
/// ```
</span><span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream);
<span class="doccomment">/// Convert `self` directly into a `TokenStream` object.
///
/// This method is implicitly implemented using `to_tokens`, and acts as a
/// convenience method for consumers of the `ToTokens` trait.
</span><span class="kw">fn </span>to_token_stream(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; TokenStream {
<span class="kw">let </span><span class="kw-2">mut </span>tokens = TokenStream::new();
<span class="self">self</span>.to_tokens(<span class="kw-2">&amp;mut </span>tokens);
tokens
}
<span class="doccomment">/// Convert `self` directly into a `TokenStream` object.
///
/// This method is implicitly implemented using `to_tokens`, and acts as a
/// convenience method for consumers of the `ToTokens` trait.
</span><span class="kw">fn </span>into_token_stream(<span class="self">self</span>) -&gt; TokenStream
<span class="kw">where
</span><span class="self">Self</span>: Sized,
{
<span class="self">self</span>.to_token_stream()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized + ToTokens&gt; ToTokens <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
(<span class="kw-2">**</span><span class="self">self</span>).to_tokens(tokens);
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized + ToTokens&gt; ToTokens <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>T {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
(<span class="kw-2">**</span><span class="self">self</span>).to_tokens(tokens);
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: <span class="question-mark">?</span>Sized + ToOwned + ToTokens&gt; ToTokens <span class="kw">for </span>Cow&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
(<span class="kw-2">**</span><span class="self">self</span>).to_tokens(tokens);
}
}
<span class="kw">impl</span>&lt;T: <span class="question-mark">?</span>Sized + ToTokens&gt; ToTokens <span class="kw">for </span>Box&lt;T&gt; {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
(<span class="kw-2">**</span><span class="self">self</span>).to_tokens(tokens);
}
}
<span class="kw">impl</span>&lt;T: <span class="question-mark">?</span>Sized + ToTokens&gt; ToTokens <span class="kw">for </span>Rc&lt;T&gt; {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
(<span class="kw-2">**</span><span class="self">self</span>).to_tokens(tokens);
}
}
<span class="kw">impl</span>&lt;T: ToTokens&gt; ToTokens <span class="kw">for </span><span class="prelude-ty">Option</span>&lt;T&gt; {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>t) = <span class="kw-2">*</span><span class="self">self </span>{
t.to_tokens(tokens);
}
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>str {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(Literal::string(<span class="self">self</span>));
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>String {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
<span class="self">self</span>.as_str().to_tokens(tokens);
}
}
<span class="macro">macro_rules! </span>primitive {
($(<span class="macro-nonterminal">$t</span>:ident =&gt; <span class="macro-nonterminal">$name</span>:ident)<span class="kw-2">*</span>) =&gt; {
$(
<span class="kw">impl </span>ToTokens <span class="kw">for </span><span class="macro-nonterminal">$t </span>{
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(Literal::<span class="macro-nonterminal">$name</span>(<span class="kw-2">*</span><span class="self">self</span>));
}
}
)*
};
}
<span class="macro">primitive! </span>{
i8 =&gt; i8_suffixed
i16 =&gt; i16_suffixed
i32 =&gt; i32_suffixed
i64 =&gt; i64_suffixed
i128 =&gt; i128_suffixed
isize =&gt; isize_suffixed
u8 =&gt; u8_suffixed
u16 =&gt; u16_suffixed
u32 =&gt; u32_suffixed
u64 =&gt; u64_suffixed
u128 =&gt; u128_suffixed
usize =&gt; usize_suffixed
f32 =&gt; f32_suffixed
f64 =&gt; f64_suffixed
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>char {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(Literal::character(<span class="kw-2">*</span><span class="self">self</span>));
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>bool {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
<span class="kw">let </span>word = <span class="kw">if </span><span class="kw-2">*</span><span class="self">self </span>{ <span class="string">&quot;true&quot; </span>} <span class="kw">else </span>{ <span class="string">&quot;false&quot; </span>};
tokens.append(Ident::new(word, Span::call_site()));
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>Group {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(<span class="self">self</span>.clone());
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>Ident {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(<span class="self">self</span>.clone());
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>Punct {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(<span class="self">self</span>.clone());
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>Literal {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, tokens: <span class="kw-2">&amp;mut </span>TokenStream) {
tokens.append(<span class="self">self</span>.clone());
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>TokenTree {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, dst: <span class="kw-2">&amp;mut </span>TokenStream) {
dst.append(<span class="self">self</span>.clone());
}
}
<span class="kw">impl </span>ToTokens <span class="kw">for </span>TokenStream {
<span class="kw">fn </span>to_tokens(<span class="kw-2">&amp;</span><span class="self">self</span>, dst: <span class="kw-2">&amp;mut </span>TokenStream) {
dst.extend(iter::once(<span class="self">self</span>.clone()));
}
<span class="kw">fn </span>into_token_stream(<span class="self">self</span>) -&gt; TokenStream {
<span class="self">self
</span>}
}
</code></pre></div>
</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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>