| <!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/proc-macro-error-1.0.4/src/diagnostic.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>diagnostic.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="../../proc_macro_error/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="../../proc_macro_error/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> |
| <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> |
| </pre><pre class="rust"><code><span class="kw">use crate</span>::{abort_now, check_correctness, sealed::Sealed, SpanRange}; |
| <span class="kw">use </span>proc_macro2::Span; |
| <span class="kw">use </span>proc_macro2::TokenStream; |
| |
| <span class="kw">use </span>quote::{quote_spanned, ToTokens}; |
| |
| <span class="doccomment">/// Represents a diagnostic level |
| /// |
| /// # Warnings |
| /// |
| /// Warnings are ignored on stable/beta |
| </span><span class="attribute">#[derive(Debug, PartialEq)] |
| </span><span class="kw">pub enum </span>Level { |
| Error, |
| Warning, |
| <span class="attribute">#[doc(hidden)] |
| </span>NonExhaustive, |
| } |
| |
| <span class="doccomment">/// Represents a single diagnostic message |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Diagnostic { |
| <span class="kw">pub</span>(<span class="kw">crate</span>) level: Level, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) span_range: SpanRange, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) msg: String, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) suggestions: Vec<(SuggestionKind, String, <span class="prelude-ty">Option</span><SpanRange>)>, |
| <span class="kw">pub</span>(<span class="kw">crate</span>) children: Vec<(SpanRange, String)>, |
| } |
| |
| <span class="doccomment">/// A collection of methods that do not exist in `proc_macro::Diagnostic` |
| /// but still useful to have around. |
| /// |
| /// This trait is sealed and cannot be implemented outside of `proc_macro_error`. |
| </span><span class="kw">pub trait </span>DiagnosticExt: Sealed { |
| <span class="doccomment">/// Create a new diagnostic message that points to the `span_range`. |
| /// |
| /// This function is the same as `Diagnostic::spanned` but produces considerably |
| /// better error messages for multi-token spans on stable. |
| </span><span class="kw">fn </span>spanned_range(span_range: SpanRange, level: Level, message: String) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Add another error message to self such that it will be emitted right after |
| /// the main message. |
| /// |
| /// This function is the same as `Diagnostic::span_error` but produces considerably |
| /// better error messages for multi-token spans on stable. |
| </span><span class="kw">fn </span>span_range_error(<span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Attach a "help" note to your main message, the note will have it's own span on nightly. |
| /// |
| /// This function is the same as `Diagnostic::span_help` but produces considerably |
| /// better error messages for multi-token spans on stable. |
| /// |
| /// # Span |
| /// |
| /// The span is ignored on stable, the note effectively inherits its parent's (main message) span |
| </span><span class="kw">fn </span>span_range_help(<span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Attach a note to your main message, the note will have it's own span on nightly. |
| /// |
| /// This function is the same as `Diagnostic::span_note` but produces considerably |
| /// better error messages for multi-token spans on stable. |
| /// |
| /// # Span |
| /// |
| /// The span is ignored on stable, the note effectively inherits its parent's (main message) span |
| </span><span class="kw">fn </span>span_range_note(<span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self</span>; |
| } |
| |
| <span class="kw">impl </span>DiagnosticExt <span class="kw">for </span>Diagnostic { |
| <span class="kw">fn </span>spanned_range(span_range: SpanRange, level: Level, message: String) -> <span class="self">Self </span>{ |
| Diagnostic { |
| level, |
| span_range, |
| msg: message, |
| suggestions: <span class="macro">vec!</span>[], |
| children: <span class="macro">vec!</span>[], |
| } |
| } |
| |
| <span class="kw">fn </span>span_range_error(<span class="kw-2">mut </span><span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.children.push((span_range, msg)); |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">fn </span>span_range_help(<span class="kw-2">mut </span><span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.suggestions |
| .push((SuggestionKind::Help, msg, <span class="prelude-val">Some</span>(span_range))); |
| <span class="self">self |
| </span>} |
| |
| <span class="kw">fn </span>span_range_note(<span class="kw-2">mut </span><span class="self">self</span>, span_range: SpanRange, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.suggestions |
| .push((SuggestionKind::Note, msg, <span class="prelude-val">Some</span>(span_range))); |
| <span class="self">self |
| </span>} |
| } |
| |
| <span class="kw">impl </span>Diagnostic { |
| <span class="doccomment">/// Create a new diagnostic message that points to `Span::call_site()` |
| </span><span class="kw">pub fn </span>new(level: Level, message: String) -> <span class="self">Self </span>{ |
| Diagnostic::spanned(Span::call_site(), level, message) |
| } |
| |
| <span class="doccomment">/// Create a new diagnostic message that points to the `span` |
| </span><span class="kw">pub fn </span>spanned(span: Span, level: Level, message: String) -> <span class="self">Self </span>{ |
| Diagnostic::spanned_range( |
| SpanRange { |
| first: span, |
| last: span, |
| }, |
| level, |
| message, |
| ) |
| } |
| |
| <span class="doccomment">/// Add another error message to self such that it will be emitted right after |
| /// the main message. |
| </span><span class="kw">pub fn </span>span_error(<span class="self">self</span>, span: Span, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.span_range_error( |
| SpanRange { |
| first: span, |
| last: span, |
| }, |
| msg, |
| ) |
| } |
| |
| <span class="doccomment">/// Attach a "help" note to your main message, the note will have it's own span on nightly. |
| /// |
| /// # Span |
| /// |
| /// The span is ignored on stable, the note effectively inherits its parent's (main message) span |
| </span><span class="kw">pub fn </span>span_help(<span class="self">self</span>, span: Span, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.span_range_help( |
| SpanRange { |
| first: span, |
| last: span, |
| }, |
| msg, |
| ) |
| } |
| |
| <span class="doccomment">/// Attach a "help" note to your main message. |
| </span><span class="kw">pub fn </span>help(<span class="kw-2">mut </span><span class="self">self</span>, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.suggestions.push((SuggestionKind::Help, msg, <span class="prelude-val">None</span>)); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// Attach a note to your main message, the note will have it's own span on nightly. |
| /// |
| /// # Span |
| /// |
| /// The span is ignored on stable, the note effectively inherits its parent's (main message) span |
| </span><span class="kw">pub fn </span>span_note(<span class="self">self</span>, span: Span, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.span_range_note( |
| SpanRange { |
| first: span, |
| last: span, |
| }, |
| msg, |
| ) |
| } |
| |
| <span class="doccomment">/// Attach a note to your main message |
| </span><span class="kw">pub fn </span>note(<span class="kw-2">mut </span><span class="self">self</span>, msg: String) -> <span class="self">Self </span>{ |
| <span class="self">self</span>.suggestions.push((SuggestionKind::Note, msg, <span class="prelude-val">None</span>)); |
| <span class="self">self |
| </span>} |
| |
| <span class="doccomment">/// The message of main warning/error (no notes attached) |
| </span><span class="kw">pub fn </span>message(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="kw-2">&</span><span class="self">self</span>.msg |
| } |
| |
| <span class="doccomment">/// Abort the proc-macro's execution and display the diagnostic. |
| /// |
| /// # Warnings |
| /// |
| /// Warnings are not emitted on stable and beta, but this function will abort anyway. |
| </span><span class="kw">pub fn </span>abort(<span class="self">self</span>) -> ! { |
| <span class="self">self</span>.emit(); |
| abort_now() |
| } |
| |
| <span class="doccomment">/// Display the diagnostic while not aborting macro execution. |
| /// |
| /// # Warnings |
| /// |
| /// Warnings are ignored on stable/beta |
| </span><span class="kw">pub fn </span>emit(<span class="self">self</span>) { |
| check_correctness(); |
| <span class="kw">crate</span>::imp::emit_diagnostic(<span class="self">self</span>); |
| } |
| } |
| |
| <span class="doccomment">/// **NOT PUBLIC API! NOTHING TO SEE HERE!!!** |
| </span><span class="attribute">#[doc(hidden)] |
| </span><span class="kw">impl </span>Diagnostic { |
| <span class="kw">pub fn </span>span_suggestion(<span class="self">self</span>, span: Span, suggestion: <span class="kw-2">&</span>str, msg: String) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>suggestion { |
| <span class="string">"help" </span>| <span class="string">"hint" </span>=> <span class="self">self</span>.span_help(span, msg), |
| <span class="kw">_ </span>=> <span class="self">self</span>.span_note(span, msg), |
| } |
| } |
| |
| <span class="kw">pub fn </span>suggestion(<span class="self">self</span>, suggestion: <span class="kw-2">&</span>str, msg: String) -> <span class="self">Self </span>{ |
| <span class="kw">match </span>suggestion { |
| <span class="string">"help" </span>| <span class="string">"hint" </span>=> <span class="self">self</span>.help(msg), |
| <span class="kw">_ </span>=> <span class="self">self</span>.note(msg), |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>ToTokens <span class="kw">for </span>Diagnostic { |
| <span class="kw">fn </span>to_tokens(<span class="kw-2">&</span><span class="self">self</span>, ts: <span class="kw-2">&mut </span>TokenStream) { |
| <span class="kw">use </span>std::borrow::Cow; |
| |
| <span class="kw">fn </span>ensure_lf(buf: <span class="kw-2">&mut </span>String, s: <span class="kw-2">&</span>str) { |
| <span class="kw">if </span>s.ends_with(<span class="string">'\n'</span>) { |
| buf.push_str(s); |
| } <span class="kw">else </span>{ |
| buf.push_str(s); |
| buf.push(<span class="string">'\n'</span>); |
| } |
| } |
| |
| <span class="kw">fn </span>diag_to_tokens( |
| span_range: SpanRange, |
| level: <span class="kw-2">&</span>Level, |
| msg: <span class="kw-2">&</span>str, |
| suggestions: <span class="kw-2">&</span>[(SuggestionKind, String, <span class="prelude-ty">Option</span><SpanRange>)], |
| ) -> TokenStream { |
| <span class="kw">if </span><span class="kw-2">*</span>level == Level::Warning { |
| <span class="kw">return </span>TokenStream::new(); |
| } |
| |
| <span class="kw">let </span>message = <span class="kw">if </span>suggestions.is_empty() { |
| Cow::Borrowed(msg) |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>message = String::new(); |
| ensure_lf(<span class="kw-2">&mut </span>message, msg); |
| message.push(<span class="string">'\n'</span>); |
| |
| <span class="kw">for </span>(kind, note, _span) <span class="kw">in </span>suggestions { |
| message.push_str(<span class="string">" = "</span>); |
| message.push_str(kind.name()); |
| message.push_str(<span class="string">": "</span>); |
| ensure_lf(<span class="kw-2">&mut </span>message, note); |
| } |
| message.push(<span class="string">'\n'</span>); |
| |
| Cow::Owned(message) |
| }; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = proc_macro2::Literal::string(<span class="kw-2">&</span>message); |
| msg.set_span(span_range.last); |
| <span class="kw">let </span>group = <span class="macro">quote_spanned!</span>(span_range.last=> { #msg } ); |
| <span class="macro">quote_spanned!</span>(span_range.first=> <span class="macro">compile_error!</span>#group) |
| } |
| |
| ts.extend(diag_to_tokens( |
| <span class="self">self</span>.span_range, |
| <span class="kw-2">&</span><span class="self">self</span>.level, |
| <span class="kw-2">&</span><span class="self">self</span>.msg, |
| <span class="kw-2">&</span><span class="self">self</span>.suggestions, |
| )); |
| ts.extend( |
| <span class="self">self</span>.children |
| .iter() |
| .map(|(span_range, msg)| diag_to_tokens(<span class="kw-2">*</span>span_range, <span class="kw-2">&</span>Level::Error, <span class="kw-2">&</span>msg, <span class="kw-2">&</span>[])), |
| ); |
| } |
| } |
| |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>SuggestionKind { |
| Help, |
| Note, |
| } |
| |
| <span class="kw">impl </span>SuggestionKind { |
| <span class="kw">fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str { |
| <span class="kw">match </span><span class="self">self </span>{ |
| SuggestionKind::Note => <span class="string">"note"</span>, |
| SuggestionKind::Help => <span class="string">"help"</span>, |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"syn-error"</span>)] |
| </span><span class="kw">impl </span>From<syn::Error> <span class="kw">for </span>Diagnostic { |
| <span class="kw">fn </span>from(err: syn::Error) -> <span class="self">Self </span>{ |
| <span class="kw">use </span>proc_macro2::{Delimiter, TokenTree}; |
| |
| <span class="kw">fn </span>gut_error(ts: <span class="kw-2">&mut </span><span class="kw">impl </span>Iterator<Item = TokenTree>) -> <span class="prelude-ty">Option</span><(SpanRange, String)> { |
| <span class="kw">let </span>first = <span class="kw">match </span>ts.next() { |
| <span class="comment">// compile_error |
| </span><span class="prelude-val">None </span>=> <span class="kw">return </span><span class="prelude-val">None</span>, |
| <span class="prelude-val">Some</span>(tt) => tt.span(), |
| }; |
| ts.next().unwrap(); <span class="comment">// ! |
| |
| </span><span class="kw">let </span>lit = <span class="kw">match </span>ts.next().unwrap() { |
| TokenTree::Group(group) => { |
| <span class="comment">// Currently `syn` builds `compile_error!` invocations |
| // exclusively in `ident{"..."}` (braced) form which is not |
| // followed by `;` (semicolon). |
| // |
| // But if it changes to `ident("...");` (parenthesized) |
| // or `ident["..."];` (bracketed) form, |
| // we will need to skip the `;` as well. |
| // Highly unlikely, but better safe than sorry. |
| |
| </span><span class="kw">if </span>group.delimiter() == Delimiter::Parenthesis |
| || group.delimiter() == Delimiter::Bracket |
| { |
| ts.next().unwrap(); <span class="comment">// ; |
| </span>} |
| |
| <span class="kw">match </span>group.stream().into_iter().next().unwrap() { |
| TokenTree::Literal(lit) => lit, |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| }; |
| |
| <span class="kw">let </span>last = lit.span(); |
| <span class="kw">let </span><span class="kw-2">mut </span>msg = lit.to_string(); |
| |
| <span class="comment">// "abc" => abc |
| </span>msg.pop(); |
| msg.remove(<span class="number">0</span>); |
| |
| <span class="prelude-val">Some</span>((SpanRange { first, last }, msg)) |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>ts = err.to_compile_error().into_iter(); |
| |
| <span class="kw">let </span>(span_range, msg) = gut_error(<span class="kw-2">&mut </span>ts).unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>res = Diagnostic::spanned_range(span_range, Level::Error, msg); |
| |
| <span class="kw">while let </span><span class="prelude-val">Some</span>((span_range, msg)) = gut_error(<span class="kw-2">&mut </span>ts) { |
| res = res.span_range_error(span_range, msg); |
| } |
| |
| res |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="proc_macro_error" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
