blob: 004650cd11f072ae125567a1156e021542d7a0a1 [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/thiserror-impl-1.0.40/src/valid.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>valid.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="../../thiserror_impl/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="../../thiserror_impl/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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::ast::{Enum, Field, Input, Struct, Variant};
<span class="kw">use </span><span class="kw">crate</span>::attr::Attrs;
<span class="kw">use </span>quote::ToTokens;
<span class="kw">use </span>std::collections::BTreeSet <span class="kw">as </span>Set;
<span class="kw">use </span>syn::{Error, GenericArgument, Member, PathArguments, <span class="prelude-ty">Result</span>, Type};
<span class="kw">impl </span>Input&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">match </span><span class="self">self </span>{
Input::Struct(input) =&gt; input.validate(),
Input::Enum(input) =&gt; input.validate(),
}
}
}
<span class="kw">impl </span>Struct&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
check_non_field_attrs(<span class="kw-2">&amp;</span><span class="self">self</span>.attrs)<span class="question-mark">?</span>;
<span class="kw">if let </span><span class="prelude-val">Some</span>(transparent) = <span class="self">self</span>.attrs.transparent {
<span class="kw">if </span><span class="self">self</span>.fields.len() != <span class="number">1 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
transparent.original,
<span class="string">&quot;#[error(transparent)] requires exactly one field&quot;</span>,
));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(source) = <span class="self">self</span>.fields.iter().find_map(|f| f.attrs.source) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
source,
<span class="string">&quot;transparent error struct can&#39;t contain #[source]&quot;</span>,
));
}
}
check_field_attrs(<span class="kw-2">&amp;</span><span class="self">self</span>.fields)<span class="question-mark">?</span>;
<span class="kw">for </span>field <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.fields {
field.validate()<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Enum&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
check_non_field_attrs(<span class="kw-2">&amp;</span><span class="self">self</span>.attrs)<span class="question-mark">?</span>;
<span class="kw">let </span>has_display = <span class="self">self</span>.has_display();
<span class="kw">for </span>variant <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.variants {
variant.validate()<span class="question-mark">?</span>;
<span class="kw">if </span>has_display &amp;&amp; variant.attrs.display.is_none() &amp;&amp; variant.attrs.transparent.is_none()
{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
variant.original,
<span class="string">&quot;missing #[error(\&quot;...\&quot;)] display attribute&quot;</span>,
));
}
}
<span class="kw">let </span><span class="kw-2">mut </span>from_types = Set::new();
<span class="kw">for </span>variant <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.variants {
<span class="kw">if let </span><span class="prelude-val">Some</span>(from_field) = variant.from_field() {
<span class="kw">let </span>repr = from_field.ty.to_token_stream().to_string();
<span class="kw">if </span>!from_types.insert(repr) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
from_field.original,
<span class="string">&quot;cannot derive From because another variant has the same source type&quot;</span>,
));
}
}
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Variant&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
check_non_field_attrs(<span class="kw-2">&amp;</span><span class="self">self</span>.attrs)<span class="question-mark">?</span>;
<span class="kw">if </span><span class="self">self</span>.attrs.transparent.is_some() {
<span class="kw">if </span><span class="self">self</span>.fields.len() != <span class="number">1 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
<span class="self">self</span>.original,
<span class="string">&quot;#[error(transparent)] requires exactly one field&quot;</span>,
));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(source) = <span class="self">self</span>.fields.iter().find_map(|f| f.attrs.source) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
source,
<span class="string">&quot;transparent variant can&#39;t contain #[source]&quot;</span>,
));
}
}
check_field_attrs(<span class="kw-2">&amp;</span><span class="self">self</span>.fields)<span class="question-mark">?</span>;
<span class="kw">for </span>field <span class="kw">in </span><span class="kw-2">&amp;</span><span class="self">self</span>.fields {
field.validate()<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Field&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>validate(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(display) = <span class="kw-2">&amp;</span><span class="self">self</span>.attrs.display {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
display.original,
<span class="string">&quot;not expected here; the #[error(...)] attribute belongs on top of a struct or an enum variant&quot;</span>,
));
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">fn </span>check_non_field_attrs(attrs: <span class="kw-2">&amp;</span>Attrs) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(from) = <span class="kw-2">&amp;</span>attrs.from {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
from,
<span class="string">&quot;not expected here; the #[from] attribute belongs on a specific field&quot;</span>,
));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(source) = <span class="kw-2">&amp;</span>attrs.source {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
source,
<span class="string">&quot;not expected here; the #[source] attribute belongs on a specific field&quot;</span>,
));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(backtrace) = <span class="kw-2">&amp;</span>attrs.backtrace {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
backtrace,
<span class="string">&quot;not expected here; the #[backtrace] attribute belongs on a specific field&quot;</span>,
));
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(display) = <span class="kw-2">&amp;</span>attrs.display {
<span class="kw">if </span>attrs.transparent.is_some() {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
display.original,
<span class="string">&quot;cannot have both #[error(transparent)] and a display attribute&quot;</span>,
));
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>check_field_attrs(fields: <span class="kw-2">&amp;</span>[Field]) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>from_field = <span class="prelude-val">None</span>;
<span class="kw">let </span><span class="kw-2">mut </span>source_field = <span class="prelude-val">None</span>;
<span class="kw">let </span><span class="kw-2">mut </span>backtrace_field = <span class="prelude-val">None</span>;
<span class="kw">let </span><span class="kw-2">mut </span>has_backtrace = <span class="bool-val">false</span>;
<span class="kw">for </span>field <span class="kw">in </span>fields {
<span class="kw">if let </span><span class="prelude-val">Some</span>(from) = field.attrs.from {
<span class="kw">if </span>from_field.is_some() {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(from, <span class="string">&quot;duplicate #[from] attribute&quot;</span>));
}
from_field = <span class="prelude-val">Some</span>(field);
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(source) = field.attrs.source {
<span class="kw">if </span>source_field.is_some() {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(source, <span class="string">&quot;duplicate #[source] attribute&quot;</span>));
}
source_field = <span class="prelude-val">Some</span>(field);
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(backtrace) = field.attrs.backtrace {
<span class="kw">if </span>backtrace_field.is_some() {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
backtrace,
<span class="string">&quot;duplicate #[backtrace] attribute&quot;</span>,
));
}
backtrace_field = <span class="prelude-val">Some</span>(field);
has_backtrace = <span class="bool-val">true</span>;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(transparent) = field.attrs.transparent {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
transparent.original,
<span class="string">&quot;#[error(transparent)] needs to go outside the enum or struct, not on an individual field&quot;</span>,
));
}
has_backtrace |= field.is_backtrace();
}
<span class="kw">if let </span>(<span class="prelude-val">Some</span>(from_field), <span class="prelude-val">Some</span>(source_field)) = (from_field, source_field) {
<span class="kw">if </span>!same_member(from_field, source_field) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
from_field.attrs.from,
<span class="string">&quot;#[from] is only supported on the source field, not any other field&quot;</span>,
));
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(from_field) = from_field {
<span class="kw">let </span>max_expected_fields = <span class="kw">match </span>backtrace_field {
<span class="prelude-val">Some</span>(backtrace_field) =&gt; <span class="number">1 </span>+ !same_member(from_field, backtrace_field) <span class="kw">as </span>usize,
<span class="prelude-val">None </span>=&gt; <span class="number">1 </span>+ has_backtrace <span class="kw">as </span>usize,
};
<span class="kw">if </span>fields.len() &gt; max_expected_fields {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
from_field.attrs.from,
<span class="string">&quot;deriving From requires no fields other than source and backtrace&quot;</span>,
));
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(source_field) = source_field.or(from_field) {
<span class="kw">if </span>contains_non_static_lifetime(source_field.ty) {
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new_spanned(
<span class="kw-2">&amp;</span>source_field.original.ty,
<span class="string">&quot;non-static lifetimes are not allowed in the source of an error, because std::error::Error requires the source is dyn Error + &#39;static&quot;</span>,
));
}
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>same_member(one: <span class="kw-2">&amp;</span>Field, two: <span class="kw-2">&amp;</span>Field) -&gt; bool {
<span class="kw">match </span>(<span class="kw-2">&amp;</span>one.member, <span class="kw-2">&amp;</span>two.member) {
(Member::Named(one), Member::Named(two)) =&gt; one == two,
(Member::Unnamed(one), Member::Unnamed(two)) =&gt; one.index == two.index,
<span class="kw">_ </span>=&gt; <span class="macro">unreachable!</span>(),
}
}
<span class="kw">fn </span>contains_non_static_lifetime(ty: <span class="kw-2">&amp;</span>Type) -&gt; bool {
<span class="kw">match </span>ty {
Type::Path(ty) =&gt; {
<span class="kw">let </span>bracketed = <span class="kw">match </span><span class="kw-2">&amp;</span>ty.path.segments.last().unwrap().arguments {
PathArguments::AngleBracketed(bracketed) =&gt; bracketed,
<span class="kw">_ </span>=&gt; <span class="kw">return </span><span class="bool-val">false</span>,
};
<span class="kw">for </span>arg <span class="kw">in </span><span class="kw-2">&amp;</span>bracketed.args {
<span class="kw">match </span>arg {
GenericArgument::Type(ty) <span class="kw">if </span>contains_non_static_lifetime(ty) =&gt; <span class="kw">return </span><span class="bool-val">true</span>,
GenericArgument::Lifetime(lifetime) <span class="kw">if </span>lifetime.ident != <span class="string">&quot;static&quot; </span>=&gt; {
<span class="kw">return </span><span class="bool-val">true
</span>}
<span class="kw">_ </span>=&gt; {}
}
}
<span class="bool-val">false
</span>}
Type::Reference(ty) =&gt; ty
.lifetime
.as_ref()
.map_or(<span class="bool-val">false</span>, |lifetime| lifetime.ident != <span class="string">&quot;static&quot;</span>),
<span class="kw">_ </span>=&gt; <span class="bool-val">false</span>, <span class="comment">// maybe implement later if there are common other cases
</span>}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="thiserror_impl" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>