blob: 1872c833f2c09045e0bec08f42be3bbcfdbdb812 [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/time-0.3.21/src/serde/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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="icon" href="https://avatars0.githubusercontent.com/u/55999857"></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="../../../time/index.html"><div class="logo-container">
<img src="https://avatars0.githubusercontent.com/u/55999857" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../time/index.html">
<img src="https://avatars0.githubusercontent.com/u/55999857" 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>
<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>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
</pre><pre class="rust"><code><span class="doccomment">//! Differential formats for serde.
</span><span class="comment">// This also includes the serde implementations for all types. This doesn&#39;t need to be externally
// documented, though.
// Types with guaranteed stable serde representations. Strings are avoided to allow for optimal
// representations in various binary forms.
</span><span class="doccomment">/// Consume the next item in a sequence.
</span><span class="macro">macro_rules! </span>item {
(<span class="macro-nonterminal">$seq</span>:expr, <span class="macro-nonterminal">$name</span>:literal) =&gt; {
<span class="macro-nonterminal">$seq</span>.next_element()<span class="question-mark">?
</span>.ok_or_else(|| &lt;A::Error <span class="kw">as </span>serde::de::Error&gt;::custom(<span class="macro">concat!</span>(<span class="string">&quot;expected &quot;</span>, <span class="macro-nonterminal">$name</span>)))
};
}
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>))]
</span><span class="kw">pub mod </span>iso8601;
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>))]
</span><span class="kw">pub mod </span>rfc2822;
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>))]
</span><span class="kw">pub mod </span>rfc3339;
<span class="kw">pub mod </span>timestamp;
<span class="kw">mod </span>visitor;
<span class="kw">use </span>core::marker::PhantomData;
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">use </span>serde::ser::Error <span class="kw">as _</span>;
<span class="kw">use </span>serde::{Deserialize, Deserializer, Serialize, Serializer};
<span class="doccomment">/// Generate a custom serializer and deserializer from a format string or an existing format.
///
/// The syntax accepted by this macro is the same as [`format_description::parse()`], which can
/// be found in [the book](https://time-rs.github.io/book/api/format-description.html).
///
/// # Usage
///
/// Invoked as `serde::format_description!(mod_name, Date, FORMAT)` where `FORMAT` is either a
/// `&quot;&lt;format string&gt;&quot;` or something that implements
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;[`Formattable`](crate::formatting::Formattable) and \
[`Parsable`](crate::parsing::Parsable).&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;[`Formattable`](crate::formatting::Formattable).&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;[`Parsable`](crate::parsing::Parsable).&quot;
</span>)]
</span><span class="doccomment">/// This puts a module named `mod_name` in the current scope that can be used to format `Date`
/// structs. A submodule (`mod_name::option`) is also generated for `Option&lt;Date&gt;`. Both
/// modules are only visible in the current scope.
///
/// The returned `Option` will contain a deserialized value if present and `None` if the field
/// is present but the value is `null` (or the equivalent in other formats). To return `None`
/// when the field is not present, you should use `#[serde(default)]` on the field.
///
/// # Examples
///
/// Using a format string:
///
/// ```rust,no_run
/// # use time::OffsetDateTime;
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::{Serialize, Deserialize};&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;use ::serde::Serialize;&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::Deserialize;&quot;
</span>)]
</span><span class="doccomment">/// use time::serde;
///
/// // Makes a module `mod my_format { ... }`.
/// serde::format_description!(my_format, OffsetDateTime, &quot;hour=[hour], minute=[minute]&quot;);
///
/// # #[allow(dead_code)]
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Serialize, Deserialize)]&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;#[derive(Serialize)]&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Deserialize)]&quot;
</span>)]
</span><span class="doccomment">/// struct SerializesWithCustom {
/// #[serde(with = &quot;my_format&quot;)]
/// dt: OffsetDateTime,
/// #[serde(with = &quot;my_format::option&quot;)]
/// maybe_dt: Option&lt;OffsetDateTime&gt;,
/// }
/// ```
///
/// Define the format separately to be used in multiple places:
/// ```rust,no_run
/// # use time::OffsetDateTime;
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::{Serialize, Deserialize};&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;use ::serde::Serialize;&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::Deserialize;&quot;
</span>)]
</span><span class="doccomment">/// use time::serde;
/// use time::format_description::FormatItem;
///
/// const DATE_TIME_FORMAT: &amp;[FormatItem&lt;&#39;_&gt;] = time::macros::format_description!(
/// &quot;hour=[hour], minute=[minute]&quot;
/// );
///
/// // Makes a module `mod my_format { ... }`.
/// serde::format_description!(my_format, OffsetDateTime, DATE_TIME_FORMAT);
///
/// # #[allow(dead_code)]
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Serialize, Deserialize)]&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;#[derive(Serialize)]&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Deserialize)]&quot;
</span>)]
</span><span class="doccomment">/// struct SerializesWithCustom {
/// #[serde(with = &quot;my_format&quot;)]
/// dt: OffsetDateTime,
/// #[serde(with = &quot;my_format::option&quot;)]
/// maybe_dt: Option&lt;OffsetDateTime&gt;,
/// }
///
/// fn main() {
/// # #[allow(unused_variables)]
/// let str_ts = OffsetDateTime::now_utc().format(DATE_TIME_FORMAT).unwrap();
/// }
/// ```
///
/// Customize the configuration of ISO 8601 formatting/parsing:
/// ```rust,no_run
/// # use time::OffsetDateTime;
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::{Serialize, Deserialize};&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;use ::serde::Serialize;&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;use ::serde::Deserialize;&quot;
</span>)]
</span><span class="doccomment">/// use time::serde;
/// use time::format_description::well_known::{iso8601, Iso8601};
///
/// const CONFIG: iso8601::EncodedConfig = iso8601::Config::DEFAULT
/// .set_year_is_six_digits(false)
/// .encode();
/// const FORMAT: Iso8601&lt;CONFIG&gt; = Iso8601::&lt;CONFIG&gt;;
///
/// // Makes a module `mod my_format { ... }`.
/// serde::format_description!(my_format, OffsetDateTime, FORMAT);
///
/// # #[allow(dead_code)]
</span><span class="attribute">#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Serialize, Deserialize)]&quot;
</span>)]
#[cfg_attr(
all(feature = <span class="string">&quot;formatting&quot;</span>, not(feature = <span class="string">&quot;parsing&quot;</span>)),
doc = <span class="string">&quot;#[derive(Serialize)]&quot;
</span>)]
#[cfg_attr(
all(not(feature = <span class="string">&quot;formatting&quot;</span>), feature = <span class="string">&quot;parsing&quot;</span>),
doc = <span class="string">&quot;#[derive(Deserialize)]&quot;
</span>)]
</span><span class="doccomment">/// struct SerializesWithCustom {
/// #[serde(with = &quot;my_format&quot;)]
/// dt: OffsetDateTime,
/// #[serde(with = &quot;my_format::option&quot;)]
/// maybe_dt: Option&lt;OffsetDateTime&gt;,
/// }
/// # fn main() {}
/// ```
///
/// [`format_description::parse()`]: crate::format_description::parse()
</span><span class="attribute">#[cfg(all(feature = <span class="string">&quot;macros&quot;</span>, any(feature = <span class="string">&quot;formatting&quot;</span>, feature = <span class="string">&quot;parsing&quot;</span>),))]
</span><span class="kw">pub use </span>time_macros::serde_format_description <span class="kw">as </span>format_description;
<span class="kw">use </span><span class="self">self</span>::visitor::Visitor;
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::format_description::{modifier, Component, FormatItem};
<span class="kw">use crate</span>::{Date, Duration, Month, OffsetDateTime, PrimitiveDateTime, Time, UtcOffset, Weekday};
<span class="comment">// region: Date
</span><span class="doccomment">/// The format used when serializing and deserializing a human-readable `Date`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">const </span>DATE_FORMAT: <span class="kw-2">&amp;</span>[FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;] = <span class="kw-2">&amp;</span>[
FormatItem::Component(Component::Year(modifier::Year::default())),
FormatItem::Literal(<span class="string">b&quot;-&quot;</span>),
FormatItem::Component(Component::Month(modifier::Month::default())),
FormatItem::Literal(<span class="string">b&quot;-&quot;</span>),
FormatItem::Component(Component::Day(modifier::Day::default())),
];
<span class="kw">impl </span>Serialize <span class="kw">for </span>Date {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">let </span><span class="prelude-val">Ok</span>(s) = <span class="self">self</span>.format(<span class="kw-2">&amp;</span>DATE_FORMAT) <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(S::Error::custom(<span class="string">&quot;failed formatting `Date`&quot;</span>));
};
<span class="kw">return </span>serializer.serialize_str(<span class="kw-2">&amp;</span>s);
}
(<span class="self">self</span>.year(), <span class="self">self</span>.ordinal()).serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>Date {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">2</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion date
// region: Duration
</span><span class="kw">impl </span>Serialize <span class="kw">for </span>Duration {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">return </span>serializer.collect_str(<span class="kw-2">&amp;</span><span class="macro">format_args!</span>(
<span class="string">&quot;{}.{:&gt;09}&quot;</span>,
<span class="self">self</span>.whole_seconds(),
<span class="self">self</span>.subsec_nanoseconds().abs()
));
}
(<span class="self">self</span>.whole_seconds(), <span class="self">self</span>.subsec_nanoseconds()).serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>Duration {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">2</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion Duration
// region: OffsetDateTime
</span><span class="doccomment">/// The format used when serializing and deserializing a human-readable `OffsetDateTime`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">const </span>OFFSET_DATE_TIME_FORMAT: <span class="kw-2">&amp;</span>[FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;] = <span class="kw-2">&amp;</span>[
FormatItem::Compound(DATE_FORMAT),
FormatItem::Literal(<span class="string">b&quot; &quot;</span>),
FormatItem::Compound(TIME_FORMAT),
FormatItem::Literal(<span class="string">b&quot; &quot;</span>),
FormatItem::Compound(UTC_OFFSET_FORMAT),
];
<span class="kw">impl </span>Serialize <span class="kw">for </span>OffsetDateTime {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">let </span><span class="prelude-val">Ok</span>(s) = <span class="self">self</span>.format(<span class="kw-2">&amp;</span>OFFSET_DATE_TIME_FORMAT) <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(S::Error::custom(<span class="string">&quot;failed formatting `OffsetDateTime`&quot;</span>));
};
<span class="kw">return </span>serializer.serialize_str(<span class="kw-2">&amp;</span>s);
}
(
<span class="self">self</span>.year(),
<span class="self">self</span>.ordinal(),
<span class="self">self</span>.hour(),
<span class="self">self</span>.minute(),
<span class="self">self</span>.second(),
<span class="self">self</span>.nanosecond(),
<span class="self">self</span>.offset().whole_hours(),
<span class="self">self</span>.offset().minutes_past_hour(),
<span class="self">self</span>.offset().seconds_past_minute(),
)
.serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>OffsetDateTime {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">9</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion OffsetDateTime
// region: PrimitiveDateTime
</span><span class="doccomment">/// The format used when serializing and deserializing a human-readable `PrimitiveDateTime`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">const </span>PRIMITIVE_DATE_TIME_FORMAT: <span class="kw-2">&amp;</span>[FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;] = <span class="kw-2">&amp;</span>[
FormatItem::Compound(DATE_FORMAT),
FormatItem::Literal(<span class="string">b&quot; &quot;</span>),
FormatItem::Compound(TIME_FORMAT),
];
<span class="kw">impl </span>Serialize <span class="kw">for </span>PrimitiveDateTime {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">let </span><span class="prelude-val">Ok</span>(s) = <span class="self">self</span>.format(<span class="kw-2">&amp;</span>PRIMITIVE_DATE_TIME_FORMAT) <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(S::Error::custom(<span class="string">&quot;failed formatting `PrimitiveDateTime`&quot;</span>));
};
<span class="kw">return </span>serializer.serialize_str(<span class="kw-2">&amp;</span>s);
}
(
<span class="self">self</span>.year(),
<span class="self">self</span>.ordinal(),
<span class="self">self</span>.hour(),
<span class="self">self</span>.minute(),
<span class="self">self</span>.second(),
<span class="self">self</span>.nanosecond(),
)
.serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>PrimitiveDateTime {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">6</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion PrimitiveDateTime
// region: Time
</span><span class="doccomment">/// The format used when serializing and deserializing a human-readable `Time`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">const </span>TIME_FORMAT: <span class="kw-2">&amp;</span>[FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;] = <span class="kw-2">&amp;</span>[
FormatItem::Component(Component::Hour(&lt;modifier::Hour&gt;::default())),
FormatItem::Literal(<span class="string">b&quot;:&quot;</span>),
FormatItem::Component(Component::Minute(&lt;modifier::Minute&gt;::default())),
FormatItem::Literal(<span class="string">b&quot;:&quot;</span>),
FormatItem::Component(Component::Second(&lt;modifier::Second&gt;::default())),
FormatItem::Literal(<span class="string">b&quot;.&quot;</span>),
FormatItem::Component(Component::Subsecond(&lt;modifier::Subsecond&gt;::default())),
];
<span class="kw">impl </span>Serialize <span class="kw">for </span>Time {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">let </span><span class="prelude-val">Ok</span>(s) = <span class="self">self</span>.format(<span class="kw-2">&amp;</span>TIME_FORMAT) <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(S::Error::custom(<span class="string">&quot;failed formatting `Time`&quot;</span>));
};
<span class="kw">return </span>serializer.serialize_str(<span class="kw-2">&amp;</span>s);
}
(<span class="self">self</span>.hour(), <span class="self">self</span>.minute(), <span class="self">self</span>.second(), <span class="self">self</span>.nanosecond()).serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>Time {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">4</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion Time
// region: UtcOffset
</span><span class="doccomment">/// The format used when serializing and deserializing a human-readable `UtcOffset`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">const </span>UTC_OFFSET_FORMAT: <span class="kw-2">&amp;</span>[FormatItem&lt;<span class="lifetime">&#39;_</span>&gt;] = <span class="kw-2">&amp;</span>[
FormatItem::Component(Component::OffsetHour(modifier::OffsetHour::default())),
FormatItem::Literal(<span class="string">b&quot;:&quot;</span>),
FormatItem::Component(Component::OffsetMinute(modifier::OffsetMinute::default())),
FormatItem::Literal(<span class="string">b&quot;:&quot;</span>),
FormatItem::Component(Component::OffsetSecond(modifier::OffsetSecond::default())),
];
<span class="kw">impl </span>Serialize <span class="kw">for </span>UtcOffset {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="kw">let </span><span class="prelude-val">Ok</span>(s) = <span class="self">self</span>.format(<span class="kw-2">&amp;</span>UTC_OFFSET_FORMAT) <span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(S::Error::custom(<span class="string">&quot;failed formatting `UtcOffset`&quot;</span>));
};
<span class="kw">return </span>serializer.serialize_str(<span class="kw-2">&amp;</span>s);
}
(
<span class="self">self</span>.whole_hours(),
<span class="self">self</span>.minutes_past_hour(),
<span class="self">self</span>.seconds_past_minute(),
)
.serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>UtcOffset {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_tuple(<span class="number">3</span>, Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion UtcOffset
// region: Weekday
</span><span class="kw">impl </span>Serialize <span class="kw">for </span>Weekday {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;std&quot;</span>))]
</span><span class="kw">use </span>alloc::string::ToString;
<span class="kw">return </span><span class="self">self</span>.to_string().serialize(serializer);
}
<span class="self">self</span>.number_from_monday().serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>Weekday {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_u8(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion Weekday
// region: Month
</span><span class="kw">impl </span>Serialize <span class="kw">for </span>Month {
<span class="kw">fn </span>serialize&lt;S: Serializer&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, serializer: S) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde-human-readable&quot;</span>)]
</span><span class="kw">if </span>serializer.is_human_readable() {
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;std&quot;</span>))]
</span><span class="kw">use </span>alloc::string::String;
<span class="kw">return </span><span class="self">self</span>.to_string().serialize(serializer);
}
(<span class="kw-2">*</span><span class="self">self </span><span class="kw">as </span>u8).serialize(serializer)
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; Deserialize&lt;<span class="lifetime">&#39;a</span>&gt; <span class="kw">for </span>Month {
<span class="kw">fn </span>deserialize&lt;D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt; {
<span class="kw">if </span><span class="macro">cfg!</span>(feature = <span class="string">&quot;serde-human-readable&quot;</span>) &amp;&amp; deserializer.is_human_readable() {
deserializer.deserialize_any(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
} <span class="kw">else </span>{
deserializer.deserialize_u8(Visitor::&lt;<span class="self">Self</span>&gt;(PhantomData))
}
}
}
<span class="comment">// endregion Month
</span></code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="time" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>