| <!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/format_description/well_known/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> |
| <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> |
| </pre><pre class="rust"><code><span class="doccomment">//! The format described in ISO 8601. |
| |
| </span><span class="kw">mod </span>adt_hack; |
| |
| <span class="kw">use </span>core::num::NonZeroU8; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::adt_hack::{DoNotRelyOnWhatThisIs, EncodedConfig}; |
| |
| <span class="doccomment">/// A configuration for [`Iso8601`] that only parses values. |
| </span><span class="kw">const </span>PARSING_ONLY: EncodedConfig = Config { |
| formatted_components: FormattedComponents::None, |
| use_separators: <span class="bool-val">false</span>, |
| year_is_six_digits: <span class="bool-val">false</span>, |
| date_kind: DateKind::Calendar, |
| time_precision: TimePrecision::Hour { |
| decimal_digits: <span class="prelude-val">None</span>, |
| }, |
| offset_precision: OffsetPrecision::Hour, |
| } |
| .encode(); |
| |
| <span class="doccomment">/// The default configuration for [`Iso8601`]. |
| </span><span class="kw">const </span>DEFAULT_CONFIG: EncodedConfig = Config::DEFAULT.encode(); |
| |
| <span class="doccomment">/// The format described in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). |
| /// |
| /// This implementation is of ISO 8601-1:2019. It may not be compatible with other versions. |
| /// |
| /// The const parameter `CONFIG` **must** be a value that was returned by [`Config::encode`]. |
| /// Passing any other value is **unspecified behavior**. |
| /// |
| /// Example: 1997-11-21T09:55:06.000000000-06:00 |
| /// |
| /// # Examples |
| </span><span class="attribute">#[cfg_attr(feature = <span class="string">"formatting"</span>, doc = <span class="string">"```rust"</span>)] |
| #[cfg_attr(not(feature = <span class="string">"formatting"</span>), doc = <span class="string">"```rust,ignore"</span>)] |
| </span><span class="doccomment">/// # use time::format_description::well_known::Iso8601; |
| /// # use time_macros::datetime; |
| /// assert_eq!( |
| /// datetime!(1997-11-12 9:55:06 -6:00).format(&Iso8601::DEFAULT)?, |
| /// "1997-11-12T09:55:06.000000000-06:00" |
| /// ); |
| /// # Ok::<_, time::Error>(()) |
| /// ``` |
| </span><span class="attribute">#[derive(Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Iso8601<<span class="kw">const </span>CONFIG: EncodedConfig = DEFAULT_CONFIG>; |
| |
| <span class="kw">impl</span><<span class="kw">const </span>CONFIG: EncodedConfig> core::fmt::Debug <span class="kw">for </span>Iso8601<CONFIG> { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>core::fmt::Formatter<<span class="lifetime">'_</span>>) -> core::fmt::Result { |
| f.debug_struct(<span class="string">"Iso8601"</span>) |
| .field(<span class="string">"config"</span>, <span class="kw-2">&</span>Config::decode(CONFIG)) |
| .finish() |
| } |
| } |
| |
| <span class="kw">impl </span>Iso8601<DEFAULT_CONFIG> { |
| <span class="doccomment">/// An [`Iso8601`] with the default configuration. |
| /// |
| /// The following is the default behavior: |
| /// |
| /// - The configuration can be used for both formatting and parsing. |
| /// - The date, time, and UTC offset are all formatted. |
| /// - Separators (such as `-` and `:`) are included. |
| /// - The year contains four digits, such that the year must be between 0 and 9999. |
| /// - The date uses the calendar format. |
| /// - The time has precision to the second and nine decimal digits. |
| /// - The UTC offset has precision to the minute. |
| /// |
| /// If you need different behavior, use [`Config::DEFAULT`] and [`Config`]'s methods to create |
| /// a custom configuration. |
| </span><span class="kw">pub const </span>DEFAULT: <span class="self">Self </span>= <span class="self">Self</span>; |
| } |
| |
| <span class="kw">impl </span>Iso8601<PARSING_ONLY> { |
| <span class="doccomment">/// An [`Iso8601`] that can only be used for parsing. Using this to format a value is |
| /// unspecified behavior. |
| </span><span class="kw">pub const </span>PARSING: <span class="self">Self </span>= <span class="self">Self</span>; |
| } |
| |
| <span class="doccomment">/// Which components to format. |
| </span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>FormattedComponents { |
| <span class="doccomment">/// The configuration can only be used for parsing. Using this to format a value is |
| /// unspecified behavior. |
| </span><span class="prelude-val">None</span>, |
| <span class="doccomment">/// Format only the date. |
| </span>Date, |
| <span class="doccomment">/// Format only the time. |
| </span>Time, |
| <span class="doccomment">/// Format only the UTC offset. |
| </span>Offset, |
| <span class="doccomment">/// Format the date and time. |
| </span>DateTime, |
| <span class="doccomment">/// Format the date, time, and UTC offset. |
| </span>DateTimeOffset, |
| <span class="doccomment">/// Format the time and UTC offset. |
| </span>TimeOffset, |
| } |
| |
| <span class="doccomment">/// Which format to use for the date. |
| </span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>DateKind { |
| <span class="doccomment">/// Use the year-month-day format. |
| </span>Calendar, |
| <span class="doccomment">/// Use the year-week-weekday format. |
| </span>Week, |
| <span class="doccomment">/// Use the week-ordinal format. |
| </span>Ordinal, |
| } |
| |
| <span class="doccomment">/// The precision and number of decimal digits present for the time. |
| </span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>TimePrecision { |
| <span class="doccomment">/// Format the hour only. Minutes, seconds, and nanoseconds will be represented with the |
| /// specified number of decimal digits, if any. |
| </span>Hour { |
| <span class="attribute">#[allow(clippy::missing_docs_in_private_items)] |
| </span>decimal_digits: <span class="prelude-ty">Option</span><NonZeroU8>, |
| }, |
| <span class="doccomment">/// Format the hour and minute. Seconds and nanoseconds will be represented with the specified |
| /// number of decimal digits, if any. |
| </span>Minute { |
| <span class="attribute">#[allow(clippy::missing_docs_in_private_items)] |
| </span>decimal_digits: <span class="prelude-ty">Option</span><NonZeroU8>, |
| }, |
| <span class="doccomment">/// Format the hour, minute, and second. Nanoseconds will be represented with the specified |
| /// number of decimal digits, if any. |
| </span>Second { |
| <span class="attribute">#[allow(clippy::missing_docs_in_private_items)] |
| </span>decimal_digits: <span class="prelude-ty">Option</span><NonZeroU8>, |
| }, |
| } |
| |
| <span class="doccomment">/// The precision for the UTC offset. |
| </span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>OffsetPrecision { |
| <span class="doccomment">/// Format only the offset hour. Requires the offset minute to be zero. |
| </span>Hour, |
| <span class="doccomment">/// Format both the offset hour and minute. |
| </span>Minute, |
| } |
| |
| <span class="doccomment">/// Configuration for [`Iso8601`]. |
| </span><span class="comment">// This is only used as a const generic, so there's no need to have a number of implementations on |
| // it. |
| </span><span class="attribute">#[allow(missing_copy_implementations)] |
| #[doc(alias = <span class="string">"EncodedConfig"</span>)] </span><span class="comment">// People will likely search for `EncodedConfig`, so show them this. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>Config { |
| <span class="doccomment">/// Which components, if any, will be formatted. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) formatted_components: FormattedComponents, |
| <span class="doccomment">/// Whether the format contains separators (such as `-` or `:`). |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) use_separators: bool, |
| <span class="doccomment">/// Whether the year is six digits. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) year_is_six_digits: bool, |
| <span class="doccomment">/// The format used for the date. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) date_kind: DateKind, |
| <span class="doccomment">/// The precision and number of decimal digits present for the time. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) time_precision: TimePrecision, |
| <span class="doccomment">/// The precision for the UTC offset. |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) offset_precision: OffsetPrecision, |
| } |
| |
| <span class="kw">impl </span>Config { |
| <span class="doccomment">/// A configuration for the [`Iso8601`] format. |
| /// |
| /// The following is the default behavior: |
| /// |
| /// - The configuration can be used for both formatting and parsing. |
| /// - The date, time, and UTC offset are all formatted. |
| /// - Separators (such as `-` and `:`) are included. |
| /// - The year contains four digits, such that the year must be between 0 and 9999. |
| /// - The date uses the calendar format. |
| /// - The time has precision to the second and nine decimal digits. |
| /// - The UTC offset has precision to the minute. |
| /// |
| /// If you need different behavior, use the setter methods on this struct. |
| </span><span class="kw">pub const </span>DEFAULT: <span class="self">Self </span>= <span class="self">Self </span>{ |
| formatted_components: FormattedComponents::DateTimeOffset, |
| use_separators: <span class="bool-val">true</span>, |
| year_is_six_digits: <span class="bool-val">false</span>, |
| date_kind: DateKind::Calendar, |
| time_precision: TimePrecision::Second { |
| decimal_digits: NonZeroU8::new(<span class="number">9</span>), |
| }, |
| offset_precision: OffsetPrecision::Minute, |
| }; |
| |
| <span class="doccomment">/// Set whether the format the date, time, and/or UTC offset. |
| </span><span class="kw">pub const fn </span>set_formatted_components(<span class="self">self</span>, formatted_components: FormattedComponents) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| formatted_components, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set whether the format contains separators (such as `-` or `:`). |
| </span><span class="kw">pub const fn </span>set_use_separators(<span class="self">self</span>, use_separators: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| use_separators, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set whether the year is six digits. |
| </span><span class="kw">pub const fn </span>set_year_is_six_digits(<span class="self">self</span>, year_is_six_digits: bool) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| year_is_six_digits, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set the format used for the date. |
| </span><span class="kw">pub const fn </span>set_date_kind(<span class="self">self</span>, date_kind: DateKind) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ date_kind, ..<span class="self">self </span>} |
| } |
| |
| <span class="doccomment">/// Set the precision and number of decimal digits present for the time. |
| </span><span class="kw">pub const fn </span>set_time_precision(<span class="self">self</span>, time_precision: TimePrecision) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| time_precision, |
| ..<span class="self">self |
| </span>} |
| } |
| |
| <span class="doccomment">/// Set the precision for the UTC offset. |
| </span><span class="kw">pub const fn </span>set_offset_precision(<span class="self">self</span>, offset_precision: OffsetPrecision) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| offset_precision, |
| ..<span class="self">self |
| </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> |