blob: bfc9c15bb00cdb11d5ea6da1a71f0dc88edc487b [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/iso8601.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>iso8601.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>
</pre><pre class="rust"><code><span class="doccomment">//! Use the well-known [ISO 8601 format] when serializing and deserializing an [`OffsetDateTime`].
//!
//! Use this module in combination with serde&#39;s [`#[with]`][with] attribute.
//!
//! [ISO 8601 format]: https://www.iso.org/iso-8601-date-and-time-format.html
//! [with]: https://serde.rs/field-attrs.html#with
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">use </span>core::marker::PhantomData;
<span class="attribute">#[cfg(feature = <span class="string">&quot;formatting&quot;</span>)]
</span><span class="kw">use </span>serde::ser::Error <span class="kw">as _</span>;
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">use </span>serde::Deserializer;
<span class="attribute">#[cfg(feature = <span class="string">&quot;formatting&quot;</span>)]
</span><span class="kw">use </span>serde::{Serialize, Serializer};
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">use </span><span class="kw">super</span>::Visitor;
<span class="kw">use </span><span class="kw">crate</span>::format_description::well_known::iso8601::{Config, EncodedConfig};
<span class="kw">use </span><span class="kw">crate</span>::format_description::well_known::Iso8601;
<span class="kw">use </span><span class="kw">crate</span>::OffsetDateTime;
<span class="doccomment">/// The configuration of ISO 8601 used for serde implementations.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>SERDE_CONFIG: EncodedConfig =
Config::DEFAULT.set_year_is_six_digits(<span class="bool-val">true</span>).encode();
<span class="doccomment">/// Serialize an [`OffsetDateTime`] using the well-known ISO 8601 format.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;formatting&quot;</span>)]
</span><span class="kw">pub fn </span>serialize&lt;S: Serializer&gt;(
datetime: <span class="kw-2">&amp;</span>OffsetDateTime,
serializer: S,
) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
datetime
.format(<span class="kw-2">&amp;</span>Iso8601::&lt;SERDE_CONFIG&gt;)
.map_err(S::Error::custom)<span class="question-mark">?
</span>.serialize(serializer)
}
<span class="doccomment">/// Deserialize an [`OffsetDateTime`] from its ISO 8601 representation.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">pub fn </span>deserialize&lt;<span class="lifetime">&#39;a</span>, D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;OffsetDateTime, D::Error&gt; {
deserializer.deserialize_str(Visitor::&lt;Iso8601&lt;SERDE_CONFIG&gt;&gt;(PhantomData))
}
<span class="doccomment">/// Use the well-known ISO 8601 format when serializing and deserializing an
/// [`Option&lt;OffsetDateTime&gt;`].
///
/// Use this module in combination with serde&#39;s [`#[with]`][with] attribute.
///
/// [ISO 8601 format]: https://www.iso.org/iso-8601-date-and-time-format.html
/// [with]: https://serde.rs/field-attrs.html#with
</span><span class="kw">pub mod </span>option {
<span class="attribute">#[allow(clippy::wildcard_imports)]
</span><span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="doccomment">/// Serialize an [`Option&lt;OffsetDateTime&gt;`] using the well-known ISO 8601 format.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;formatting&quot;</span>)]
</span><span class="kw">pub fn </span>serialize&lt;S: Serializer&gt;(
option: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;OffsetDateTime&gt;,
serializer: S,
) -&gt; <span class="prelude-ty">Result</span>&lt;S::Ok, S::Error&gt; {
option
.map(|odt| odt.format(<span class="kw-2">&amp;</span>Iso8601::&lt;SERDE_CONFIG&gt;))
.transpose()
.map_err(S::Error::custom)<span class="question-mark">?
</span>.serialize(serializer)
}
<span class="doccomment">/// Deserialize an [`Option&lt;OffsetDateTime&gt;`] from its ISO 8601 representation.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">pub fn </span>deserialize&lt;<span class="lifetime">&#39;a</span>, D: Deserializer&lt;<span class="lifetime">&#39;a</span>&gt;&gt;(
deserializer: D,
) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="prelude-ty">Option</span>&lt;OffsetDateTime&gt;, D::Error&gt; {
deserializer.deserialize_option(Visitor::&lt;<span class="prelude-ty">Option</span>&lt;Iso8601&lt;SERDE_CONFIG&gt;&gt;&gt;(PhantomData))
}
}
</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>