blob: 320ff84f2b708f41a697df75c7449b639f8de5f0 [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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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>
</pre><pre class="rust"><code><span class="doccomment">//! # Feature flags
//!
//! This crate exposes a number of features. These can be enabled or disabled as shown
//! [in Cargo&#39;s documentation](https://doc.rust-lang.org/cargo/reference/features.html). Features
//! are _disabled_ by default unless otherwise noted.
//!
//! Reliance on a given feature is always indicated alongside the item definition.
//!
//! - `std` (_enabled by default, implicitly enables `alloc`_)
//!
//! This enables a number of features that depend on the standard library.
//!
//! - `alloc` (_enabled by default via `std`_)
//!
//! Enables a number of features that require the ability to dynamically allocate memory.
//!
//! - `macros`
//!
//! Enables macros that provide compile-time verification of values and intuitive syntax.
//!
//! - `formatting` (_implicitly enables `std`_)
//!
//! Enables formatting of most structs.
//!
//! - `parsing`
//!
//! Enables parsing of most structs.
//!
//! - `local-offset` (_implicitly enables `std`_)
//!
//! This feature enables a number of methods that allow obtaining the system&#39;s UTC offset.
//!
//! - `large-dates`
//!
//! By default, only years within the ±9999 range (inclusive) are supported. If you need support
//! for years outside this range, consider enabling this feature; the supported range will be
//! increased to ±999,999.
//!
//! Note that enabling this feature has some costs, as it means forgoing some optimizations.
//! Ambiguities may be introduced when parsing that would not otherwise exist.
//!
//! - `serde`
//!
//! Enables [serde](https://docs.rs/serde) support for all types except [`Instant`].
//!
//! - `serde-human-readable` (_implicitly enables `serde`, `formatting`, and `parsing`_)
//!
//! Allows serde representations to use a human-readable format. This is determined by the
//! serializer, not the user. If this feature is not enabled or if the serializer requests a
//! non-human-readable format, a format optimized for binary representation will be used.
//!
//! Libraries should never enable this feature, as the decision of what format to use should be up
//! to the user.
//!
//! - `serde-well-known` (_implicitly enables `serde-human-readable`_)
//!
//! _This feature flag is deprecated and will be removed in a future breaking release. Use the
//! `serde-human-readable` feature instead._
//!
//! Enables support for serializing and deserializing well-known formats using serde&#39;s
//! [`#[with]` attribute](https://serde.rs/field-attrs.html#with).
//!
//! - `rand`
//!
//! Enables [rand](https://docs.rs/rand) support for all types.
//!
//! - `quickcheck` (_implicitly enables `alloc`_)
//!
//! Enables [quickcheck](https://docs.rs/quickcheck) support for all types except [`Instant`].
//!
//! - `wasm-bindgen`
//!
//! Enables [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) support for converting
//! [JavaScript dates](https://rustwasm.github.io/wasm-bindgen/api/js_sys/struct.Date.html), as
//! well as obtaining the UTC offset from JavaScript.
</span><span class="attribute">#![doc(html_playground_url = <span class="string">&quot;https://play.rust-lang.org&quot;</span>)]
#![cfg_attr(__time_03_docs, feature(doc_auto_cfg, doc_notable_trait))]
#![cfg_attr(coverage_nightly, feature(no_coverage))]
#![cfg_attr(not(feature = <span class="string">&quot;std&quot;</span>), no_std)]
#![deny(
anonymous_parameters,
clippy::all,
clippy::alloc_instead_of_core,
clippy::explicit_auto_deref,
clippy::obfuscated_if_else,
clippy::std_instead_of_core,
clippy::undocumented_unsafe_blocks,
illegal_floating_point_literal_pattern,
late_bound_lifetime_arguments,
path_statements,
patterns_in_fns_without_body,
rust_2018_idioms,
trivial_casts,
trivial_numeric_casts,
unreachable_pub,
unsafe_op_in_unsafe_fn,
unused_extern_crates,
rustdoc::broken_intra_doc_links,
rustdoc::private_intra_doc_links
)]
#![warn(
clippy::dbg_macro,
clippy::decimal_literal_representation,
clippy::get_unwrap,
clippy::missing_docs_in_private_items,
clippy::nursery,
clippy::print_stdout,
clippy::todo,
clippy::unimplemented,
clippy::uninlined_format_args,
clippy::unnested_or_patterns,
clippy::unwrap_in_result,
clippy::unwrap_used,
clippy::use_debug,
deprecated_in_future,
missing_copy_implementations,
missing_debug_implementations,
unused_qualifications,
variant_size_differences
)]
#![allow(
clippy::redundant_pub_crate, <span class="comment">// suggests bad style
</span>clippy::option_if_let_else, <span class="comment">// suggests terrible code
</span>clippy::unused_peekable, <span class="comment">// temporary due to bug: remove when Rust 1.66 is released
</span>clippy::std_instead_of_core, <span class="comment">// temporary due to bug: remove when Rust 1.66 is released
</span>)]
#![doc(html_favicon_url = <span class="string">&quot;https://avatars0.githubusercontent.com/u/55999857&quot;</span>)]
#![doc(html_logo_url = <span class="string">&quot;https://avatars0.githubusercontent.com/u/55999857&quot;</span>)]
#![doc(test(attr(deny(warnings))))]
#[allow(unused_extern_crates)]
#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">extern crate </span>alloc;
<span class="comment">// TODO(jhpratt) remove this after a while
</span><span class="attribute">#[cfg(unsound_local_offset)]
</span><span class="macro">compile_error!</span>(
<span class="string">&quot;The `unsound_local_offset` flag was removed in time 0.3.18. If you need this functionality, \
see the `time::util::local_offset::set_soundness` function.&quot;
</span>);
<span class="comment">// region: macros
</span><span class="doccomment">/// Helper macro for easily implementing `OpAssign`.
</span><span class="macro">macro_rules! </span>__impl_assign {
(<span class="macro-nonterminal">$sym</span>:tt <span class="macro-nonterminal">$op</span>:ident <span class="macro-nonterminal">$</span><span class="kw">fn</span>:<span class="macro-nonterminal">ident $target</span>:ty : $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$t</span>:ty),+) =&gt; {$(
<span class="attribute">#[allow(unused_qualifications)]
</span>$(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)*
<span class="kw">impl </span>core::ops::<span class="macro-nonterminal">$op</span>&lt;<span class="macro-nonterminal">$t</span>&gt; <span class="kw">for </span><span class="macro-nonterminal">$target </span>{
<span class="kw">fn </span><span class="macro-nonterminal">$</span><span class="kw">fn</span>(<span class="kw-2">&amp;mut </span><span class="macro-nonterminal">self</span>, rhs: <span class="macro-nonterminal">$t</span>) {
<span class="kw-2">*</span><span class="self">self </span>= <span class="kw-2">*</span><span class="self">self </span><span class="macro-nonterminal">$sym </span>rhs;
}
}
)+};
}
<span class="doccomment">/// Implement `AddAssign` for the provided types.
</span><span class="macro">macro_rules! </span>impl_add_assign {
(<span class="macro-nonterminal">$target</span>:ty : $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">?</span>) =&gt; {
<span class="macro">__impl_assign!</span>(+ AddAssign add_assign <span class="macro-nonterminal">$target </span>: $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="macro-nonterminal">$t</span>),+);
};
}
<span class="doccomment">/// Implement `SubAssign` for the provided types.
</span><span class="macro">macro_rules! </span>impl_sub_assign {
(<span class="macro-nonterminal">$target</span>:ty : $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">?</span>) =&gt; {
<span class="macro">__impl_assign!</span>(- SubAssign sub_assign <span class="macro-nonterminal">$target </span>: $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="macro-nonterminal">$t</span>),+);
};
}
<span class="doccomment">/// Implement `MulAssign` for the provided types.
</span><span class="macro">macro_rules! </span>impl_mul_assign {
(<span class="macro-nonterminal">$target</span>:ty : $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">?</span>) =&gt; {
<span class="macro">__impl_assign!</span>(* MulAssign mul_assign <span class="macro-nonterminal">$target </span>: $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="macro-nonterminal">$t</span>),+);
};
}
<span class="doccomment">/// Implement `DivAssign` for the provided types.
</span><span class="macro">macro_rules! </span>impl_div_assign {
(<span class="macro-nonterminal">$target</span>:ty : $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)* <span class="macro-nonterminal">$t</span>:ty),+ $(,)<span class="question-mark">?</span>) =&gt; {
<span class="macro">__impl_assign!</span>(/ DivAssign div_assign <span class="macro-nonterminal">$target </span>: $($(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)* <span class="macro-nonterminal">$t</span>),+);
};
}
<span class="doccomment">/// Division of integers, rounding the resulting value towards negative infinity.
</span><span class="macro">macro_rules! </span>div_floor {
(<span class="macro-nonterminal">$a</span>:expr, <span class="macro-nonterminal">$b</span>:expr) =&gt; {{
<span class="kw">let </span>_a = <span class="macro-nonterminal">$a</span>;
<span class="kw">let </span>_b = <span class="macro-nonterminal">$b</span>;
<span class="kw">let </span>(_quotient, _remainder) = (_a / _b, _a % _b);
<span class="kw">if </span>(_remainder &gt; <span class="number">0 </span>&amp;&amp; _b &lt; <span class="number">0</span>) || (_remainder &lt; <span class="number">0 </span>&amp;&amp; _b &gt; <span class="number">0</span>) {
_quotient - <span class="number">1
</span>} <span class="kw">else </span>{
_quotient
}
}};
}
<span class="doccomment">/// Cascade an out-of-bounds value.
</span><span class="macro">macro_rules! </span>cascade {
(@ordinal ordinal) =&gt; {};
(@year year) =&gt; {};
<span class="comment">// Cascade an out-of-bounds value from &quot;from&quot; to &quot;to&quot;.
</span>(<span class="macro-nonterminal">$from</span>:ident <span class="kw">in </span><span class="macro-nonterminal">$min</span>:literal.. <span class="macro-nonterminal">$max</span>:expr =&gt; <span class="macro-nonterminal">$to</span>:tt) =&gt; {
<span class="attribute">#[allow(unused_comparisons, unused_assignments)]
</span><span class="kw">let </span>min = <span class="macro-nonterminal">$min</span>;
<span class="kw">let </span>max = <span class="macro-nonterminal">$max</span>;
<span class="kw">if </span><span class="macro-nonterminal">$from </span>&gt;= max {
<span class="macro-nonterminal">$from </span>-= max - min;
<span class="macro-nonterminal">$to </span>+= <span class="number">1</span>;
} <span class="kw">else if </span><span class="macro-nonterminal">$from </span>&lt; min {
<span class="macro-nonterminal">$from </span>+= max - min;
<span class="macro-nonterminal">$to </span>-= <span class="number">1</span>;
}
};
<span class="comment">// Special case the ordinal-to-year cascade, as it has different behavior.
</span>(<span class="macro-nonterminal">$ordinal</span>:ident =&gt; <span class="macro-nonterminal">$year</span>:ident) =&gt; {
<span class="comment">// We need to actually capture the idents. Without this, macro hygiene causes errors.
</span><span class="macro">cascade!</span>(@ordinal <span class="macro-nonterminal">$ordinal</span>);
<span class="macro">cascade!</span>(@year <span class="macro-nonterminal">$year</span>);
<span class="attribute">#[allow(unused_assignments)]
</span><span class="kw">if </span><span class="macro-nonterminal">$ordinal </span>&gt; <span class="kw">crate</span>::util::days_in_year(<span class="macro-nonterminal">$year</span>) <span class="kw">as </span>i16 {
<span class="macro-nonterminal">$ordinal </span>-= <span class="kw">crate</span>::util::days_in_year(<span class="macro-nonterminal">$year</span>) <span class="kw">as </span>i16;
<span class="macro-nonterminal">$year </span>+= <span class="number">1</span>;
} <span class="kw">else if </span><span class="macro-nonterminal">$ordinal </span>&lt; <span class="number">1 </span>{
<span class="macro-nonterminal">$year </span>-= <span class="number">1</span>;
<span class="macro-nonterminal">$ordinal </span>+= <span class="kw">crate</span>::util::days_in_year(<span class="macro-nonterminal">$year</span>) <span class="kw">as </span>i16;
}
};
}
<span class="doccomment">/// Returns `Err(error::ComponentRange)` if the value is not in range.
</span><span class="macro">macro_rules! </span>ensure_value_in_range {
(<span class="macro-nonterminal">$value</span>:ident <span class="kw">in </span><span class="macro-nonterminal">$start</span>:expr =&gt; <span class="macro-nonterminal">$end</span>:expr) =&gt; {{
<span class="kw">let </span>_start = <span class="macro-nonterminal">$start</span>;
<span class="kw">let </span>_end = <span class="macro-nonterminal">$end</span>;
<span class="attribute">#[allow(trivial_numeric_casts, unused_comparisons)]
</span><span class="kw">if </span><span class="macro-nonterminal">$value </span>&lt; _start || <span class="macro-nonterminal">$value </span>&gt; _end {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::ComponentRange {
name: <span class="macro">stringify!</span>(<span class="macro-nonterminal">$value</span>),
minimum: _start <span class="kw">as _</span>,
maximum: _end <span class="kw">as _</span>,
value: <span class="macro-nonterminal">$value </span><span class="kw">as _</span>,
conditional_range: <span class="bool-val">false</span>,
});
}
}};
(<span class="macro-nonterminal">$value</span>:ident conditionally <span class="kw">in </span><span class="macro-nonterminal">$start</span>:expr =&gt; <span class="macro-nonterminal">$end</span>:expr) =&gt; {{
<span class="kw">let </span>_start = <span class="macro-nonterminal">$start</span>;
<span class="kw">let </span>_end = <span class="macro-nonterminal">$end</span>;
<span class="attribute">#[allow(trivial_numeric_casts, unused_comparisons)]
</span><span class="kw">if </span><span class="macro-nonterminal">$value </span>&lt; _start || <span class="macro-nonterminal">$value </span>&gt; _end {
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="kw">crate</span>::error::ComponentRange {
name: <span class="macro">stringify!</span>(<span class="macro-nonterminal">$value</span>),
minimum: _start <span class="kw">as _</span>,
maximum: _end <span class="kw">as _</span>,
value: <span class="macro-nonterminal">$value </span><span class="kw">as _</span>,
conditional_range: <span class="bool-val">true</span>,
});
}
}};
}
<span class="doccomment">/// Try to unwrap an expression, returning if not possible.
///
/// This is similar to the `?` operator, but does not perform `.into()`. Because of this, it is
/// usable in `const` contexts.
</span><span class="macro">macro_rules! </span>const_try {
(<span class="macro-nonterminal">$e</span>:expr) =&gt; {
<span class="kw">match </span><span class="macro-nonterminal">$e </span>{
<span class="prelude-val">Ok</span>(value) =&gt; value,
<span class="prelude-val">Err</span>(error) =&gt; <span class="kw">return </span><span class="prelude-val">Err</span>(error),
}
};
}
<span class="doccomment">/// Try to unwrap an expression, returning if not possible.
///
/// This is similar to the `?` operator, but is usable in `const` contexts.
</span><span class="macro">macro_rules! </span>const_try_opt {
(<span class="macro-nonterminal">$e</span>:expr) =&gt; {
<span class="kw">match </span><span class="macro-nonterminal">$e </span>{
<span class="prelude-val">Some</span>(value) =&gt; value,
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span><span class="prelude-val">None</span>,
}
};
}
<span class="doccomment">/// Try to unwrap an expression, panicking if not possible.
///
/// This is similar to `$e.expect($message)`, but is usable in `const` contexts.
</span><span class="macro">macro_rules! </span>expect_opt {
(<span class="macro-nonterminal">$e</span>:expr, <span class="macro-nonterminal">$message</span>:literal) =&gt; {
<span class="kw">match </span><span class="macro-nonterminal">$e </span>{
<span class="prelude-val">Some</span>(value) =&gt; value,
<span class="prelude-val">None </span>=&gt; <span class="kw">crate</span>::expect_failed(<span class="macro-nonterminal">$message</span>),
}
};
}
<span class="doccomment">/// `unreachable!()`, but better.
</span><span class="macro">macro_rules! </span>bug {
() =&gt; { <span class="macro">compile_error!</span>(<span class="string">&quot;provide an error message to help fix a possible bug&quot;</span>) };
(<span class="macro-nonterminal">$descr</span>:literal $(<span class="macro-nonterminal">$rest</span>:tt)<span class="question-mark">?</span>) =&gt; {
<span class="macro">panic!</span>(<span class="macro">concat!</span>(<span class="string">&quot;internal error: &quot;</span>, <span class="macro-nonterminal">$descr</span>) $(<span class="macro-nonterminal">$rest</span>)<span class="question-mark">?</span>)
}
}
<span class="comment">// endregion macros
</span><span class="kw">mod </span>date;
<span class="kw">mod </span>date_time;
<span class="kw">mod </span>duration;
<span class="kw">pub mod </span>error;
<span class="kw">pub mod </span>ext;
<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>format_description;
<span class="attribute">#[cfg(feature = <span class="string">&quot;formatting&quot;</span>)]
</span><span class="kw">pub mod </span>formatting;
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">mod </span>instant;
<span class="attribute">#[cfg(feature = <span class="string">&quot;macros&quot;</span>)]
</span><span class="kw">pub mod </span>macros;
<span class="kw">mod </span>month;
<span class="kw">mod </span>offset_date_time;
<span class="attribute">#[cfg(feature = <span class="string">&quot;parsing&quot;</span>)]
</span><span class="kw">pub mod </span>parsing;
<span class="kw">mod </span>primitive_date_time;
<span class="attribute">#[cfg(feature = <span class="string">&quot;quickcheck&quot;</span>)]
</span><span class="kw">mod </span>quickcheck;
<span class="attribute">#[cfg(feature = <span class="string">&quot;rand&quot;</span>)]
</span><span class="kw">mod </span>rand;
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde&quot;</span>)]
#[allow(missing_copy_implementations, missing_debug_implementations)]
</span><span class="kw">pub mod </span>serde;
<span class="kw">mod </span>sys;
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests;
<span class="kw">mod </span>time;
<span class="kw">mod </span>utc_offset;
<span class="kw">pub mod </span>util;
<span class="kw">mod </span>weekday;
<span class="comment">// Not public yet.
</span><span class="kw">use </span>time_core::convert;
<span class="kw">pub use </span><span class="kw">crate</span>::date::Date;
<span class="kw">use </span><span class="kw">crate</span>::date_time::DateTime;
<span class="kw">pub use </span><span class="kw">crate</span>::duration::Duration;
<span class="kw">pub use </span><span class="kw">crate</span>::error::Error;
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub use </span><span class="kw">crate</span>::instant::Instant;
<span class="kw">pub use </span><span class="kw">crate</span>::month::Month;
<span class="kw">pub use </span><span class="kw">crate</span>::offset_date_time::OffsetDateTime;
<span class="kw">pub use </span><span class="kw">crate</span>::primitive_date_time::PrimitiveDateTime;
<span class="kw">pub use </span><span class="kw">crate</span>::time::Time;
<span class="kw">pub use </span><span class="kw">crate</span>::utc_offset::UtcOffset;
<span class="kw">pub use </span><span class="kw">crate</span>::weekday::Weekday;
<span class="doccomment">/// An alias for [`std::result::Result`] with a generic error from the time crate.
</span><span class="kw">pub type </span><span class="prelude-ty">Result</span>&lt;T&gt; = core::result::Result&lt;T, Error&gt;;
<span class="doccomment">/// This is a separate function to reduce the code size of `expect_opt!`.
</span><span class="attribute">#[inline(never)]
#[cold]
#[track_caller]
</span><span class="kw">const fn </span>expect_failed(message: <span class="kw-2">&amp;</span>str) -&gt; ! {
<span class="macro">panic!</span>(<span class="string">&quot;{}&quot;</span>, message)
}
</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>