blob: 642473677daaa7bad660f0544256462a693ff6ac [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 `&#x2F;home&#x2F;runner&#x2F;.cargo&#x2F;registry&#x2F;src&#x2F;github.com-1ecc6299db9ec823&#x2F;syn-1.0.85&#x2F;src&#x2F;error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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" 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 src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../syn/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
</pre><pre class="rust"><code><span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;parsing&quot;</span>)]</span>
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::buffer::Cursor</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::thread::ThreadBound</span>;
<span class="kw">use</span> <span class="ident">proc_macro2</span>::{
<span class="ident">Delimiter</span>, <span class="ident">Group</span>, <span class="ident">Ident</span>, <span class="ident">LexError</span>, <span class="ident">Literal</span>, <span class="ident">Punct</span>, <span class="ident">Spacing</span>, <span class="ident">Span</span>, <span class="ident">TokenStream</span>, <span class="ident">TokenTree</span>,
};
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;printing&quot;</span>)]</span>
<span class="kw">use</span> <span class="ident">quote::ToTokens</span>;
<span class="kw">use</span> <span class="ident">std::fmt</span>::{<span class="self">self</span>, <span class="ident">Debug</span>, <span class="ident">Display</span>};
<span class="kw">use</span> <span class="ident">std::iter::FromIterator</span>;
<span class="kw">use</span> <span class="ident">std::slice</span>;
<span class="kw">use</span> <span class="ident">std::vec</span>;
<span class="doccomment">/// The result of a Syn parser.</span>
<span class="kw">pub</span> <span class="kw">type</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">T</span><span class="op">&gt;</span> <span class="op">=</span> <span class="ident">std::result::Result</span><span class="op">&lt;</span><span class="ident">T</span>, <span class="ident">Error</span><span class="op">&gt;</span>;
<span class="doccomment">/// Error returned when a Syn parser cannot parse the input tokens.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Error reporting in proc macros</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The correct way to report errors back to the compiler from a procedural</span>
<span class="doccomment">/// macro is by emitting an appropriately spanned invocation of</span>
<span class="doccomment">/// [`compile_error!`] in the generated code. This produces a better diagnostic</span>
<span class="doccomment">/// message than simply panicking the macro.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`compile_error!`]: std::compile_error!</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When parsing macro input, the [`parse_macro_input!`] macro handles the</span>
<span class="doccomment">/// conversion to `compile_error!` automatically.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate proc_macro;</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// use proc_macro::TokenStream;</span>
<span class="doccomment">/// use syn::{parse_macro_input, AttributeArgs, ItemFn};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # const IGNORE: &amp;str = stringify! {</span>
<span class="doccomment">/// #[proc_macro_attribute]</span>
<span class="doccomment">/// # };</span>
<span class="doccomment">/// pub fn my_attr(args: TokenStream, input: TokenStream) -&gt; TokenStream {</span>
<span class="doccomment">/// let args = parse_macro_input!(args as AttributeArgs);</span>
<span class="doccomment">/// let input = parse_macro_input!(input as ItemFn);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// /* ... */</span>
<span class="doccomment">/// # TokenStream::new()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For errors that arise later than the initial parsing stage, the</span>
<span class="doccomment">/// [`.to_compile_error()`] or [`.into_compile_error()`] methods can be used to</span>
<span class="doccomment">/// perform an explicit conversion to `compile_error!`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`.to_compile_error()`]: Error::to_compile_error</span>
<span class="doccomment">/// [`.into_compile_error()`]: Error::into_compile_error</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate proc_macro;</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # use proc_macro::TokenStream;</span>
<span class="doccomment">/// # use syn::{parse_macro_input, DeriveInput};</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # const IGNORE: &amp;str = stringify! {</span>
<span class="doccomment">/// #[proc_macro_derive(MyDerive)]</span>
<span class="doccomment">/// # };</span>
<span class="doccomment">/// pub fn my_derive(input: TokenStream) -&gt; TokenStream {</span>
<span class="doccomment">/// let input = parse_macro_input!(input as DeriveInput);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // fn(DeriveInput) -&gt; syn::Result&lt;proc_macro2::TokenStream&gt;</span>
<span class="doccomment">/// expand::my_derive(input)</span>
<span class="doccomment">/// .unwrap_or_else(syn::Error::into_compile_error)</span>
<span class="doccomment">/// .into()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # mod expand {</span>
<span class="doccomment">/// # use proc_macro2::TokenStream;</span>
<span class="doccomment">/// # use syn::{DeriveInput, Result};</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// # pub fn my_derive(input: DeriveInput) -&gt; Result&lt;TokenStream&gt; {</span>
<span class="doccomment">/// # unimplemented!()</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="ident">Vec</span><span class="op">&lt;</span><span class="ident">ErrorMessage</span><span class="op">&gt;</span>,
}
<span class="kw">struct</span> <span class="ident">ErrorMessage</span> {
<span class="comment">// Span is implemented as an index into a thread-local interner to keep the</span>
<span class="comment">// size small. It is not safe to access from a different thread. We want</span>
<span class="comment">// errors to be Send and Sync to play nicely with the Failure crate, so pin</span>
<span class="comment">// the span we&#39;re given to its original thread and assume it is</span>
<span class="comment">// Span::call_site if accessed from any other thread.</span>
<span class="ident">start_span</span>: <span class="ident">ThreadBound</span><span class="op">&lt;</span><span class="ident">Span</span><span class="op">&gt;</span>,
<span class="ident">end_span</span>: <span class="ident">ThreadBound</span><span class="op">&lt;</span><span class="ident">Span</span><span class="op">&gt;</span>,
<span class="ident">message</span>: <span class="ident">String</span>,
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">struct</span> <span class="ident">_Test</span>
<span class="kw">where</span>
<span class="ident">Error</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>;
<span class="kw">impl</span> <span class="ident">Error</span> {
<span class="doccomment">/// Usually the [`ParseStream::error`] method will be used instead, which</span>
<span class="doccomment">/// automatically uses the correct span from the current position of the</span>
<span class="doccomment">/// parse stream.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `Error::new` when the error needs to be triggered on some span other</span>
<span class="doccomment">/// than where the parse stream is currently positioned.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`ParseStream::error`]: crate::parse::ParseBuffer::error</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use syn::{Error, Ident, LitStr, Result, Token};</span>
<span class="doccomment">/// use syn::parse::ParseStream;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // Parses input that looks like `name = &quot;string&quot;` where the key must be</span>
<span class="doccomment">/// // the identifier `name` and the value may be any string literal.</span>
<span class="doccomment">/// // Returns the string literal.</span>
<span class="doccomment">/// fn parse_name(input: ParseStream) -&gt; Result&lt;LitStr&gt; {</span>
<span class="doccomment">/// let name_token: Ident = input.parse()?;</span>
<span class="doccomment">/// if name_token != &quot;name&quot; {</span>
<span class="doccomment">/// // Trigger an error not on the current position of the stream,</span>
<span class="doccomment">/// // but on the position of the unexpected identifier.</span>
<span class="doccomment">/// return Err(Error::new(name_token.span(), &quot;expected `name`&quot;));</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// input.parse::&lt;Token![=]&gt;()?;</span>
<span class="doccomment">/// let s: LitStr = input.parse()?;</span>
<span class="doccomment">/// Ok(s)</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Display</span><span class="op">&gt;</span>(<span class="ident">span</span>: <span class="ident">Span</span>, <span class="ident">message</span>: <span class="ident">T</span>) -&gt; <span class="self">Self</span> {
<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="macro">vec!</span>[<span class="ident">ErrorMessage</span> {
<span class="ident">start_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">span</span>),
<span class="ident">end_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">span</span>),
<span class="ident">message</span>: <span class="ident">message</span>.<span class="ident">to_string</span>(),
}],
}
}
<span class="doccomment">/// Creates an error with the specified message spanning the given syntax</span>
<span class="doccomment">/// tree node.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unlike the `Error::new` constructor, this constructor takes an argument</span>
<span class="doccomment">/// `tokens` which is a syntax tree node. This allows the resulting `Error`</span>
<span class="doccomment">/// to attempt to span all tokens inside of `tokens`. While you would</span>
<span class="doccomment">/// typically be able to use the `Spanned` trait with the above `Error::new`</span>
<span class="doccomment">/// constructor, implementation limitations today mean that</span>
<span class="doccomment">/// `Error::new_spanned` may provide a higher-quality error message on</span>
<span class="doccomment">/// stable Rust.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When in doubt it&#39;s recommended to stick to `Error::new` (or</span>
<span class="doccomment">/// `ParseStream::error`)!</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;printing&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_spanned</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">ToTokens</span>, <span class="ident">U</span>: <span class="ident">Display</span><span class="op">&gt;</span>(<span class="ident">tokens</span>: <span class="ident">T</span>, <span class="ident">message</span>: <span class="ident">U</span>) -&gt; <span class="self">Self</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iter</span> <span class="op">=</span> <span class="ident">tokens</span>.<span class="ident">into_token_stream</span>().<span class="ident">into_iter</span>();
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="ident">iter</span>.<span class="ident">next</span>().<span class="ident">map_or_else</span>(<span class="ident">Span::call_site</span>, <span class="op">|</span><span class="ident">t</span><span class="op">|</span> <span class="ident">t</span>.<span class="ident">span</span>());
<span class="kw">let</span> <span class="ident">end</span> <span class="op">=</span> <span class="ident">iter</span>.<span class="ident">last</span>().<span class="ident">map_or</span>(<span class="ident">start</span>, <span class="op">|</span><span class="ident">t</span><span class="op">|</span> <span class="ident">t</span>.<span class="ident">span</span>());
<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="macro">vec!</span>[<span class="ident">ErrorMessage</span> {
<span class="ident">start_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">start</span>),
<span class="ident">end_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">end</span>),
<span class="ident">message</span>: <span class="ident">message</span>.<span class="ident">to_string</span>(),
}],
}
}
<span class="doccomment">/// The source location of the error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Spans are not thread-safe so this function returns `Span::call_site()`</span>
<span class="doccomment">/// if called from a different thread than the one on which the `Error` was</span>
<span class="doccomment">/// originally created.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">span</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">Span</span> {
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">messages</span>[<span class="number">0</span>].<span class="ident">start_span</span>.<span class="ident">get</span>() {
<span class="prelude-val">Some</span>(<span class="ident">span</span>) =&gt; <span class="kw-2">*</span><span class="ident">span</span>,
<span class="prelude-val">None</span> =&gt; <span class="kw">return</span> <span class="ident">Span::call_site</span>(),
};
<span class="kw">let</span> <span class="ident">end</span> <span class="op">=</span> <span class="kw">match</span> <span class="self">self</span>.<span class="ident">messages</span>[<span class="number">0</span>].<span class="ident">end_span</span>.<span class="ident">get</span>() {
<span class="prelude-val">Some</span>(<span class="ident">span</span>) =&gt; <span class="kw-2">*</span><span class="ident">span</span>,
<span class="prelude-val">None</span> =&gt; <span class="kw">return</span> <span class="ident">Span::call_site</span>(),
};
<span class="ident">start</span>.<span class="ident">join</span>(<span class="ident">end</span>).<span class="ident">unwrap_or</span>(<span class="ident">start</span>)
}
<span class="doccomment">/// Render the error as an invocation of [`compile_error!`].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The [`parse_macro_input!`] macro provides a convenient way to invoke</span>
<span class="doccomment">/// this method correctly in a procedural macro.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`compile_error!`]: std::compile_error!</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">to_compile_error</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">TokenStream</span> {
<span class="self">self</span>.<span class="ident">messages</span>
.<span class="ident">iter</span>()
.<span class="ident">map</span>(<span class="ident">ErrorMessage::to_compile_error</span>)
.<span class="ident">collect</span>()
}
<span class="doccomment">/// Render the error as an invocation of [`compile_error!`].</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [`compile_error!`]: std::compile_error!</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// # extern crate proc_macro;</span>
<span class="doccomment">/// #</span>
<span class="doccomment">/// use proc_macro::TokenStream;</span>
<span class="doccomment">/// use syn::{parse_macro_input, DeriveInput, Error};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # const _: &amp;str = stringify! {</span>
<span class="doccomment">/// #[proc_macro_derive(MyTrait)]</span>
<span class="doccomment">/// # };</span>
<span class="doccomment">/// pub fn derive_my_trait(input: TokenStream) -&gt; TokenStream {</span>
<span class="doccomment">/// let input = parse_macro_input!(input as DeriveInput);</span>
<span class="doccomment">/// my_trait::expand(input)</span>
<span class="doccomment">/// .unwrap_or_else(Error::into_compile_error)</span>
<span class="doccomment">/// .into()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// mod my_trait {</span>
<span class="doccomment">/// use proc_macro2::TokenStream;</span>
<span class="doccomment">/// use syn::{DeriveInput, Result};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// pub(crate) fn expand(input: DeriveInput) -&gt; Result&lt;TokenStream&gt; {</span>
<span class="doccomment">/// /* ... */</span>
<span class="doccomment">/// # unimplemented!()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_compile_error</span>(<span class="self">self</span>) -&gt; <span class="ident">TokenStream</span> {
<span class="self">self</span>.<span class="ident">to_compile_error</span>()
}
<span class="doccomment">/// Add another error message to self such that when `to_compile_error()` is</span>
<span class="doccomment">/// called, both errors will be emitted together.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">combine</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>, <span class="ident">another</span>: <span class="ident">Error</span>) {
<span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">extend</span>(<span class="ident">another</span>.<span class="ident">messages</span>);
}
}
<span class="kw">impl</span> <span class="ident">ErrorMessage</span> {
<span class="kw">fn</span> <span class="ident">to_compile_error</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">TokenStream</span> {
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="self">self</span>
.<span class="ident">start_span</span>
.<span class="ident">get</span>()
.<span class="ident">cloned</span>()
.<span class="ident">unwrap_or_else</span>(<span class="ident">Span::call_site</span>);
<span class="kw">let</span> <span class="ident">end</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">end_span</span>.<span class="ident">get</span>().<span class="ident">cloned</span>().<span class="ident">unwrap_or_else</span>(<span class="ident">Span::call_site</span>);
<span class="comment">// compile_error!($message)</span>
<span class="ident">TokenStream::from_iter</span>(<span class="macro">vec!</span>[
<span class="ident">TokenTree::Ident</span>(<span class="ident">Ident::new</span>(<span class="string">&quot;compile_error&quot;</span>, <span class="ident">start</span>)),
<span class="ident">TokenTree::Punct</span>({
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">punct</span> <span class="op">=</span> <span class="ident">Punct::new</span>(<span class="string">&#39;!&#39;</span>, <span class="ident">Spacing::Alone</span>);
<span class="ident">punct</span>.<span class="ident">set_span</span>(<span class="ident">start</span>);
<span class="ident">punct</span>
}),
<span class="ident">TokenTree::Group</span>({
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">group</span> <span class="op">=</span> <span class="ident">Group::new</span>(<span class="ident">Delimiter::Brace</span>, {
<span class="ident">TokenStream::from_iter</span>(<span class="macro">vec!</span>[<span class="ident">TokenTree::Literal</span>({
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">string</span> <span class="op">=</span> <span class="ident">Literal::string</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">message</span>);
<span class="ident">string</span>.<span class="ident">set_span</span>(<span class="ident">end</span>);
<span class="ident">string</span>
})])
});
<span class="ident">group</span>.<span class="ident">set_span</span>(<span class="ident">end</span>);
<span class="ident">group</span>
}),
])
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;parsing&quot;</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_at</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Display</span><span class="op">&gt;</span>(<span class="ident">scope</span>: <span class="ident">Span</span>, <span class="ident">cursor</span>: <span class="ident">Cursor</span>, <span class="ident">message</span>: <span class="ident">T</span>) -&gt; <span class="ident">Error</span> {
<span class="kw">if</span> <span class="ident">cursor</span>.<span class="ident">eof</span>() {
<span class="ident">Error::new</span>(<span class="ident">scope</span>, <span class="macro">format!</span>(<span class="string">&quot;unexpected end of input, {}&quot;</span>, <span class="ident">message</span>))
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="ident">span</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::buffer::open_span_of_group</span>(<span class="ident">cursor</span>);
<span class="ident">Error::new</span>(<span class="ident">span</span>, <span class="ident">message</span>)
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;parsing&quot;</span>, <span class="ident">any</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;full&quot;</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;derive&quot;</span>)))]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new2</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">Display</span><span class="op">&gt;</span>(<span class="ident">start</span>: <span class="ident">Span</span>, <span class="ident">end</span>: <span class="ident">Span</span>, <span class="ident">message</span>: <span class="ident">T</span>) -&gt; <span class="ident">Error</span> {
<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="macro">vec!</span>[<span class="ident">ErrorMessage</span> {
<span class="ident">start_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">start</span>),
<span class="ident">end_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">end</span>),
<span class="ident">message</span>: <span class="ident">message</span>.<span class="ident">to_string</span>(),
}],
}
}
<span class="kw">impl</span> <span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">formatter</span>: <span class="kw-2">&amp;mut</span> <span class="ident">fmt::Formatter</span>) -&gt; <span class="ident">fmt::Result</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">len</span>() <span class="op">==</span> <span class="number">1</span> {
<span class="ident">formatter</span>
.<span class="ident">debug_tuple</span>(<span class="string">&quot;Error&quot;</span>)
.<span class="ident">field</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">messages</span>[<span class="number">0</span>])
.<span class="ident">finish</span>()
} <span class="kw">else</span> {
<span class="ident">formatter</span>
.<span class="ident">debug_tuple</span>(<span class="string">&quot;Error&quot;</span>)
.<span class="ident">field</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">messages</span>)
.<span class="ident">finish</span>()
}
}
}
<span class="kw">impl</span> <span class="ident">Debug</span> <span class="kw">for</span> <span class="ident">ErrorMessage</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">formatter</span>: <span class="kw-2">&amp;mut</span> <span class="ident">fmt::Formatter</span>) -&gt; <span class="ident">fmt::Result</span> {
<span class="ident">Debug::fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">message</span>, <span class="ident">formatter</span>)
}
}
<span class="kw">impl</span> <span class="ident">Display</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">formatter</span>: <span class="kw-2">&amp;mut</span> <span class="ident">fmt::Formatter</span>) -&gt; <span class="ident">fmt::Result</span> {
<span class="ident">formatter</span>.<span class="ident">write_str</span>(<span class="kw-2">&amp;</span><span class="self">self</span>.<span class="ident">messages</span>[<span class="number">0</span>].<span class="ident">message</span>)
}
}
<span class="kw">impl</span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span> {
<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">clone</span>(),
}
}
}
<span class="kw">impl</span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">ErrorMessage</span> {
<span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="self">self</span>
.<span class="ident">start_span</span>
.<span class="ident">get</span>()
.<span class="ident">cloned</span>()
.<span class="ident">unwrap_or_else</span>(<span class="ident">Span::call_site</span>);
<span class="kw">let</span> <span class="ident">end</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">end_span</span>.<span class="ident">get</span>().<span class="ident">cloned</span>().<span class="ident">unwrap_or_else</span>(<span class="ident">Span::call_site</span>);
<span class="ident">ErrorMessage</span> {
<span class="ident">start_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">start</span>),
<span class="ident">end_span</span>: <span class="ident">ThreadBound::new</span>(<span class="ident">end</span>),
<span class="ident">message</span>: <span class="self">self</span>.<span class="ident">message</span>.<span class="ident">clone</span>(),
}
}
}
<span class="kw">impl</span> <span class="ident">std::error::Error</span> <span class="kw">for</span> <span class="ident">Error</span> {}
<span class="kw">impl</span> <span class="ident">From</span><span class="op">&lt;</span><span class="ident">LexError</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">LexError</span>) -&gt; <span class="self">Self</span> {
<span class="ident">Error::new</span>(<span class="ident">err</span>.<span class="ident">span</span>(), <span class="string">&quot;lex error&quot;</span>)
}
}
<span class="kw">impl</span> <span class="ident">IntoIterator</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">Error</span>;
<span class="kw">type</span> <span class="ident">IntoIter</span> <span class="op">=</span> <span class="ident">IntoIter</span>;
<span class="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) -&gt; <span class="ident"><span class="self">Self</span>::IntoIter</span> {
<span class="ident">IntoIter</span> {
<span class="ident">messages</span>: <span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">into_iter</span>(),
}
}
}
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">IntoIter</span> {
<span class="ident">messages</span>: <span class="ident">vec::IntoIter</span><span class="op">&lt;</span><span class="ident">ErrorMessage</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">IntoIter</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident"><span class="self">Self</span>::Item</span><span class="op">&gt;</span> {
<span class="prelude-val">Some</span>(<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="macro">vec!</span>[<span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">next</span>()<span class="question-mark">?</span>],
})
}
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IntoIterator</span> <span class="kw">for</span> <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">Error</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">Error</span>;
<span class="kw">type</span> <span class="ident">IntoIter</span> <span class="op">=</span> <span class="ident">Iter</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span>;
<span class="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) -&gt; <span class="ident"><span class="self">Self</span>::IntoIter</span> {
<span class="ident">Iter</span> {
<span class="ident">messages</span>: <span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">iter</span>(),
}
}
}
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Iter</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="ident">messages</span>: <span class="ident">slice::Iter</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span>, <span class="ident">ErrorMessage</span><span class="op">&gt;</span>,
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">Iter</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">Error</span>;
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="ident"><span class="self">Self</span>::Item</span><span class="op">&gt;</span> {
<span class="prelude-val">Some</span>(<span class="ident">Error</span> {
<span class="ident">messages</span>: <span class="macro">vec!</span>[<span class="self">self</span>.<span class="ident">messages</span>.<span class="ident">next</span>()<span class="question-mark">?</span>.<span class="ident">clone</span>()],
})
}
}
<span class="kw">impl</span> <span class="ident">Extend</span><span class="op">&lt;</span><span class="ident">Error</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">Error</span> {
<span class="kw">fn</span> <span class="ident">extend</span><span class="op">&lt;</span><span class="ident">T</span>: <span class="ident">IntoIterator</span><span class="op">&lt;</span><span class="ident">Item</span> <span class="op">=</span> <span class="ident">Error</span><span class="op">&gt;</span><span class="op">&gt;</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>, <span class="ident">iter</span>: <span class="ident">T</span>) {
<span class="kw">for</span> <span class="ident">err</span> <span class="kw">in</span> <span class="ident">iter</span> {
<span class="self">self</span>.<span class="ident">combine</span>(<span class="ident">err</span>);
}
}
}
</code></pre></div>
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="syn" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div>
</body></html>