blob: 993e0e4a5d11f28cc952ec6d243fc534a62a7476 [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/serde_derive-1.0.163/src/internals/ast.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ast.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="../../../serde_derive/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="../../../serde_derive/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>
</pre><pre class="rust"><code><span class="doccomment">//! A Serde ast, parsed from the Syn ast and ready to generate Rust code.
</span><span class="kw">use </span>internals::attr;
<span class="kw">use </span>internals::check;
<span class="kw">use </span>internals::{Ctxt, Derive};
<span class="kw">use </span>syn;
<span class="kw">use </span>syn::punctuated::Punctuated;
<span class="doccomment">/// A source data structure annotated with `#[derive(Serialize)]` and/or `#[derive(Deserialize)]`,
/// parsed into an internal representation.
</span><span class="kw">pub struct </span>Container&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// The struct or enum name (without generics).
</span><span class="kw">pub </span>ident: syn::Ident,
<span class="doccomment">/// Attributes on the structure, parsed for Serde.
</span><span class="kw">pub </span>attrs: attr::Container,
<span class="doccomment">/// The contents of the struct or enum.
</span><span class="kw">pub </span>data: Data&lt;<span class="lifetime">&#39;a</span>&gt;,
<span class="doccomment">/// Any generics on the struct or enum.
</span><span class="kw">pub </span>generics: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::Generics,
<span class="doccomment">/// Original input.
</span><span class="kw">pub </span>original: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::DeriveInput,
}
<span class="doccomment">/// The fields of a struct or enum.
///
/// Analogous to `syn::Data`.
</span><span class="kw">pub enum </span>Data&lt;<span class="lifetime">&#39;a</span>&gt; {
Enum(Vec&lt;Variant&lt;<span class="lifetime">&#39;a</span>&gt;&gt;),
Struct(Style, Vec&lt;Field&lt;<span class="lifetime">&#39;a</span>&gt;&gt;),
}
<span class="doccomment">/// A variant of an enum.
</span><span class="kw">pub struct </span>Variant&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>ident: syn::Ident,
<span class="kw">pub </span>attrs: attr::Variant,
<span class="kw">pub </span>style: Style,
<span class="kw">pub </span>fields: Vec&lt;Field&lt;<span class="lifetime">&#39;a</span>&gt;&gt;,
<span class="kw">pub </span>original: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::Variant,
}
<span class="doccomment">/// A field of a struct.
</span><span class="kw">pub struct </span>Field&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>member: syn::Member,
<span class="kw">pub </span>attrs: attr::Field,
<span class="kw">pub </span>ty: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::Type,
<span class="kw">pub </span>original: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::Field,
}
<span class="attribute">#[derive(Copy, Clone)]
</span><span class="kw">pub enum </span>Style {
<span class="doccomment">/// Named fields.
</span>Struct,
<span class="doccomment">/// Many unnamed fields.
</span>Tuple,
<span class="doccomment">/// One unnamed field.
</span>Newtype,
<span class="doccomment">/// No fields.
</span>Unit,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Container&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// Convert the raw Syn ast into a parsed container object, collecting errors in `cx`.
</span><span class="kw">pub fn </span>from_ast(
cx: <span class="kw-2">&amp;</span>Ctxt,
item: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::DeriveInput,
derive: Derive,
) -&gt; <span class="prelude-ty">Option</span>&lt;Container&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>attrs = attr::Container::from_ast(cx, item);
<span class="kw">let </span><span class="kw-2">mut </span>data = <span class="kw">match </span><span class="kw-2">&amp;</span>item.data {
syn::Data::Enum(data) =&gt; Data::Enum(enum_from_ast(cx, <span class="kw-2">&amp;</span>data.variants, attrs.default())),
syn::Data::Struct(data) =&gt; {
<span class="kw">let </span>(style, fields) = struct_from_ast(cx, <span class="kw-2">&amp;</span>data.fields, <span class="prelude-val">None</span>, attrs.default());
Data::Struct(style, fields)
}
syn::Data::Union(<span class="kw">_</span>) =&gt; {
cx.error_spanned_by(item, <span class="string">&quot;Serde does not support derive for unions&quot;</span>);
<span class="kw">return </span><span class="prelude-val">None</span>;
}
};
<span class="kw">let </span><span class="kw-2">mut </span>has_flatten = <span class="bool-val">false</span>;
<span class="kw">match </span><span class="kw-2">&amp;mut </span>data {
Data::Enum(variants) =&gt; {
<span class="kw">for </span>variant <span class="kw">in </span>variants {
variant.attrs.rename_by_rules(attrs.rename_all_rules());
<span class="kw">for </span>field <span class="kw">in </span><span class="kw-2">&amp;mut </span>variant.fields {
<span class="kw">if </span>field.attrs.flatten() {
has_flatten = <span class="bool-val">true</span>;
}
field
.attrs
.rename_by_rules(variant.attrs.rename_all_rules());
}
}
}
Data::Struct(<span class="kw">_</span>, fields) =&gt; {
<span class="kw">for </span>field <span class="kw">in </span>fields {
<span class="kw">if </span>field.attrs.flatten() {
has_flatten = <span class="bool-val">true</span>;
}
field.attrs.rename_by_rules(attrs.rename_all_rules());
}
}
}
<span class="kw">if </span>has_flatten {
attrs.mark_has_flatten();
}
<span class="kw">let </span><span class="kw-2">mut </span>item = Container {
ident: item.ident.clone(),
attrs,
data,
generics: <span class="kw-2">&amp;</span>item.generics,
original: item,
};
check::check(cx, <span class="kw-2">&amp;mut </span>item, derive);
<span class="prelude-val">Some</span>(item)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Data&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub fn </span>all_fields(<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="self">self</span>) -&gt; Box&lt;Iterator&lt;Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Field&lt;<span class="lifetime">&#39;a</span>&gt;&gt; + <span class="lifetime">&#39;a</span>&gt; {
<span class="kw">match </span><span class="self">self </span>{
Data::Enum(variants) =&gt; {
Box::new(variants.iter().flat_map(|variant| variant.fields.iter()))
}
Data::Struct(<span class="kw">_</span>, fields) =&gt; Box::new(fields.iter()),
}
}
<span class="kw">pub fn </span>has_getter(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.all_fields().any(|f| f.attrs.getter().is_some())
}
}
<span class="kw">fn </span>enum_from_ast&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;</span>Ctxt,
variants: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Punctuated&lt;syn::Variant, <span class="macro">Token!</span>[,]&gt;,
container_default: <span class="kw-2">&amp;</span>attr::Default,
) -&gt; Vec&lt;Variant&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
variants
.iter()
.map(|variant| {
<span class="kw">let </span>attrs = attr::Variant::from_ast(cx, variant);
<span class="kw">let </span>(style, fields) =
struct_from_ast(cx, <span class="kw-2">&amp;</span>variant.fields, <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>attrs), container_default);
Variant {
ident: variant.ident.clone(),
attrs,
style,
fields,
original: variant,
}
})
.collect()
}
<span class="kw">fn </span>struct_from_ast&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;</span>Ctxt,
fields: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>syn::Fields,
attrs: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>attr::Variant&gt;,
container_default: <span class="kw-2">&amp;</span>attr::Default,
) -&gt; (Style, Vec&lt;Field&lt;<span class="lifetime">&#39;a</span>&gt;&gt;) {
<span class="kw">match </span>fields {
syn::Fields::Named(fields) =&gt; (
Style::Struct,
fields_from_ast(cx, <span class="kw-2">&amp;</span>fields.named, attrs, container_default),
),
syn::Fields::Unnamed(fields) <span class="kw">if </span>fields.unnamed.len() == <span class="number">1 </span>=&gt; (
Style::Newtype,
fields_from_ast(cx, <span class="kw-2">&amp;</span>fields.unnamed, attrs, container_default),
),
syn::Fields::Unnamed(fields) =&gt; (
Style::Tuple,
fields_from_ast(cx, <span class="kw-2">&amp;</span>fields.unnamed, attrs, container_default),
),
syn::Fields::Unit =&gt; (Style::Unit, Vec::new()),
}
}
<span class="kw">fn </span>fields_from_ast&lt;<span class="lifetime">&#39;a</span>&gt;(
cx: <span class="kw-2">&amp;</span>Ctxt,
fields: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>Punctuated&lt;syn::Field, <span class="macro">Token!</span>[,]&gt;,
attrs: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>attr::Variant&gt;,
container_default: <span class="kw-2">&amp;</span>attr::Default,
) -&gt; Vec&lt;Field&lt;<span class="lifetime">&#39;a</span>&gt;&gt; {
fields
.iter()
.enumerate()
.map(|(i, field)| Field {
member: <span class="kw">match </span><span class="kw-2">&amp;</span>field.ident {
<span class="prelude-val">Some</span>(ident) =&gt; syn::Member::Named(ident.clone()),
<span class="prelude-val">None </span>=&gt; syn::Member::Unnamed(i.into()),
},
attrs: attr::Field::from_ast(cx, i, field, attrs, container_default),
ty: <span class="kw-2">&amp;</span>field.ty,
original: field,
})
.collect()
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="serde_derive" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>