blob: e38a309a82d2dd7e005221c7851ecdc7a4a2d862 [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/chrono-0.4.26/src/month.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>month.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../chrono/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<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>
</pre><pre class="rust"><code><span class="kw">use </span>core::fmt;
<span class="attribute">#[cfg(feature = <span class="string">&quot;rkyv&quot;</span>)]
</span><span class="kw">use </span>rkyv::{Archive, Deserialize, Serialize};
<span class="kw">use </span><span class="kw">crate</span>::OutOfRange;
<span class="doccomment">/// The month of the year.
///
/// This enum is just a convenience implementation.
/// The month in dates created by DateLike objects does not return this enum.
///
/// It is possible to convert from a date to a month independently
/// ```
/// use chrono::prelude::*;
/// let date = Utc.with_ymd_and_hms(2019, 10, 28, 9, 10, 11).unwrap();
/// // `2019-10-28T09:10:11Z`
/// let month = Month::try_from(u8::try_from(date.month()).unwrap()).ok();
/// assert_eq!(month, Some(Month::October))
/// ```
/// Or from a Month to an integer usable by dates
/// ```
/// # use chrono::prelude::*;
/// let month = Month::January;
/// let dt = Utc.with_ymd_and_hms(2019, month.number_from_month(), 28, 9, 10, 11).unwrap();
/// assert_eq!((dt.year(), dt.month(), dt.day()), (2019, 1, 28));
/// ```
/// Allows mapping from and to month, from 1-January to 12-December.
/// Can be Serialized/Deserialized with serde
</span><span class="comment">// Actual implementation is zero-indexed, API intended as 1-indexed for more intuitive behavior.
</span><span class="attribute">#[derive(PartialEq, Eq, Copy, Clone, Debug, Hash, PartialOrd)]
#[cfg_attr(feature = <span class="string">&quot;rustc-serialize&quot;</span>, derive(RustcEncodable, RustcDecodable))]
#[cfg_attr(feature = <span class="string">&quot;rkyv&quot;</span>, derive(Archive, Deserialize, Serialize))]
#[cfg_attr(feature = <span class="string">&quot;arbitrary&quot;</span>, derive(arbitrary::Arbitrary))]
</span><span class="kw">pub enum </span>Month {
<span class="doccomment">/// January
</span>January = <span class="number">0</span>,
<span class="doccomment">/// February
</span>February = <span class="number">1</span>,
<span class="doccomment">/// March
</span>March = <span class="number">2</span>,
<span class="doccomment">/// April
</span>April = <span class="number">3</span>,
<span class="doccomment">/// May
</span>May = <span class="number">4</span>,
<span class="doccomment">/// June
</span>June = <span class="number">5</span>,
<span class="doccomment">/// July
</span>July = <span class="number">6</span>,
<span class="doccomment">/// August
</span>August = <span class="number">7</span>,
<span class="doccomment">/// September
</span>September = <span class="number">8</span>,
<span class="doccomment">/// October
</span>October = <span class="number">9</span>,
<span class="doccomment">/// November
</span>November = <span class="number">10</span>,
<span class="doccomment">/// December
</span>December = <span class="number">11</span>,
}
<span class="kw">impl </span>Month {
<span class="doccomment">/// The next month.
///
/// `m`: | `January` | `February` | `...` | `December`
/// ----------- | --------- | ---------- | --- | ---------
/// `m.succ()`: | `February` | `March` | `...` | `January`
</span><span class="attribute">#[inline]
#[must_use]
</span><span class="kw">pub const fn </span>succ(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Month {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Month::January =&gt; Month::February,
Month::February =&gt; Month::March,
Month::March =&gt; Month::April,
Month::April =&gt; Month::May,
Month::May =&gt; Month::June,
Month::June =&gt; Month::July,
Month::July =&gt; Month::August,
Month::August =&gt; Month::September,
Month::September =&gt; Month::October,
Month::October =&gt; Month::November,
Month::November =&gt; Month::December,
Month::December =&gt; Month::January,
}
}
<span class="doccomment">/// The previous month.
///
/// `m`: | `January` | `February` | `...` | `December`
/// ----------- | --------- | ---------- | --- | ---------
/// `m.pred()`: | `December` | `January` | `...` | `November`
</span><span class="attribute">#[inline]
#[must_use]
</span><span class="kw">pub const fn </span>pred(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Month {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Month::January =&gt; Month::December,
Month::February =&gt; Month::January,
Month::March =&gt; Month::February,
Month::April =&gt; Month::March,
Month::May =&gt; Month::April,
Month::June =&gt; Month::May,
Month::July =&gt; Month::June,
Month::August =&gt; Month::July,
Month::September =&gt; Month::August,
Month::October =&gt; Month::September,
Month::November =&gt; Month::October,
Month::December =&gt; Month::November,
}
}
<span class="doccomment">/// Returns a month-of-year number starting from January = 1.
///
/// `m`: | `January` | `February` | `...` | `December`
/// -------------------------| --------- | ---------- | --- | -----
/// `m.number_from_month()`: | 1 | 2 | `...` | 12
</span><span class="attribute">#[inline]
#[must_use]
</span><span class="kw">pub const fn </span>number_from_month(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u32 {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Month::January =&gt; <span class="number">1</span>,
Month::February =&gt; <span class="number">2</span>,
Month::March =&gt; <span class="number">3</span>,
Month::April =&gt; <span class="number">4</span>,
Month::May =&gt; <span class="number">5</span>,
Month::June =&gt; <span class="number">6</span>,
Month::July =&gt; <span class="number">7</span>,
Month::August =&gt; <span class="number">8</span>,
Month::September =&gt; <span class="number">9</span>,
Month::October =&gt; <span class="number">10</span>,
Month::November =&gt; <span class="number">11</span>,
Month::December =&gt; <span class="number">12</span>,
}
}
<span class="doccomment">/// Get the name of the month
///
/// ```
/// use chrono::Month;
///
/// assert_eq!(Month::January.name(), &quot;January&quot;)
/// ```
</span><span class="attribute">#[must_use]
</span><span class="kw">pub const fn </span>name(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
Month::January =&gt; <span class="string">&quot;January&quot;</span>,
Month::February =&gt; <span class="string">&quot;February&quot;</span>,
Month::March =&gt; <span class="string">&quot;March&quot;</span>,
Month::April =&gt; <span class="string">&quot;April&quot;</span>,
Month::May =&gt; <span class="string">&quot;May&quot;</span>,
Month::June =&gt; <span class="string">&quot;June&quot;</span>,
Month::July =&gt; <span class="string">&quot;July&quot;</span>,
Month::August =&gt; <span class="string">&quot;August&quot;</span>,
Month::September =&gt; <span class="string">&quot;September&quot;</span>,
Month::October =&gt; <span class="string">&quot;October&quot;</span>,
Month::November =&gt; <span class="string">&quot;November&quot;</span>,
Month::December =&gt; <span class="string">&quot;December&quot;</span>,
}
}
}
<span class="kw">impl </span>TryFrom&lt;u8&gt; <span class="kw">for </span>Month {
<span class="kw">type </span>Error = OutOfRange;
<span class="kw">fn </span>try_from(value: u8) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, <span class="self">Self</span>::Error&gt; {
<span class="kw">match </span>value {
<span class="number">1 </span>=&gt; <span class="prelude-val">Ok</span>(Month::January),
<span class="number">2 </span>=&gt; <span class="prelude-val">Ok</span>(Month::February),
<span class="number">3 </span>=&gt; <span class="prelude-val">Ok</span>(Month::March),
<span class="number">4 </span>=&gt; <span class="prelude-val">Ok</span>(Month::April),
<span class="number">5 </span>=&gt; <span class="prelude-val">Ok</span>(Month::May),
<span class="number">6 </span>=&gt; <span class="prelude-val">Ok</span>(Month::June),
<span class="number">7 </span>=&gt; <span class="prelude-val">Ok</span>(Month::July),
<span class="number">8 </span>=&gt; <span class="prelude-val">Ok</span>(Month::August),
<span class="number">9 </span>=&gt; <span class="prelude-val">Ok</span>(Month::September),
<span class="number">10 </span>=&gt; <span class="prelude-val">Ok</span>(Month::October),
<span class="number">11 </span>=&gt; <span class="prelude-val">Ok</span>(Month::November),
<span class="number">12 </span>=&gt; <span class="prelude-val">Ok</span>(Month::December),
<span class="kw">_ </span>=&gt; <span class="prelude-val">Err</span>(OutOfRange::new()),
}
}
}
<span class="kw">impl </span>num_traits::FromPrimitive <span class="kw">for </span>Month {
<span class="doccomment">/// Returns an `Option&lt;Month&gt;` from a i64, assuming a 1-index, January = 1.
///
/// `Month::from_i64(n: i64)`: | `1` | `2` | ... | `12`
/// ---------------------------| -------------------- | --------------------- | ... | -----
/// ``: | Some(Month::January) | Some(Month::February) | ... | Some(Month::December)
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>from_u64(n: u64) -&gt; <span class="prelude-ty">Option</span>&lt;Month&gt; {
<span class="self">Self</span>::from_u32(n <span class="kw">as </span>u32)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>from_i64(n: i64) -&gt; <span class="prelude-ty">Option</span>&lt;Month&gt; {
<span class="self">Self</span>::from_u32(n <span class="kw">as </span>u32)
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>from_u32(n: u32) -&gt; <span class="prelude-ty">Option</span>&lt;Month&gt; {
<span class="kw">match </span>n {
<span class="number">1 </span>=&gt; <span class="prelude-val">Some</span>(Month::January),
<span class="number">2 </span>=&gt; <span class="prelude-val">Some</span>(Month::February),
<span class="number">3 </span>=&gt; <span class="prelude-val">Some</span>(Month::March),
<span class="number">4 </span>=&gt; <span class="prelude-val">Some</span>(Month::April),
<span class="number">5 </span>=&gt; <span class="prelude-val">Some</span>(Month::May),
<span class="number">6 </span>=&gt; <span class="prelude-val">Some</span>(Month::June),
<span class="number">7 </span>=&gt; <span class="prelude-val">Some</span>(Month::July),
<span class="number">8 </span>=&gt; <span class="prelude-val">Some</span>(Month::August),
<span class="number">9 </span>=&gt; <span class="prelude-val">Some</span>(Month::September),
<span class="number">10 </span>=&gt; <span class="prelude-val">Some</span>(Month::October),
<span class="number">11 </span>=&gt; <span class="prelude-val">Some</span>(Month::November),
<span class="number">12 </span>=&gt; <span class="prelude-val">Some</span>(Month::December),
<span class="kw">_ </span>=&gt; <span class="prelude-val">None</span>,
}
}
}
<span class="doccomment">/// A duration in calendar months
</span><span class="attribute">#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd)]
#[cfg_attr(feature = <span class="string">&quot;arbitrary&quot;</span>, derive(arbitrary::Arbitrary))]
</span><span class="kw">pub struct </span>Months(<span class="kw">pub</span>(<span class="kw">crate</span>) u32);
<span class="kw">impl </span>Months {
<span class="doccomment">/// Construct a new `Months` from a number of months
</span><span class="kw">pub const fn </span>new(num: u32) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>(num)
}
}
<span class="doccomment">/// An error resulting from reading `&lt;Month&gt;` value with `FromStr`.
</span><span class="attribute">#[derive(Clone, PartialEq, Eq)]
</span><span class="kw">pub struct </span>ParseMonthError {
<span class="kw">pub</span>(<span class="kw">crate</span>) _dummy: (),
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ParseMonthError {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;ParseMonthError {{ .. }}&quot;</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;serde&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;serde&quot;</span>)))]
</span><span class="kw">mod </span>month_serde {
<span class="kw">use </span><span class="kw">super</span>::Month;
<span class="kw">use </span>serde::{de, ser};
<span class="kw">use </span>core::fmt;
<span class="kw">impl </span>ser::Serialize <span class="kw">for </span>Month {
<span class="kw">fn </span>serialize&lt;S&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="kw">where
</span>S: ser::Serializer,
{
serializer.collect_str(<span class="self">self</span>.name())
}
}
<span class="kw">struct </span>MonthVisitor;
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>&gt; de::Visitor&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>MonthVisitor {
<span class="kw">type </span>Value = Month;
<span class="kw">fn </span>expecting(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
f.write_str(<span class="string">&quot;Month&quot;</span>)
}
<span class="kw">fn </span>visit_str&lt;E&gt;(<span class="self">self</span>, value: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>::Value, E&gt;
<span class="kw">where
</span>E: de::Error,
{
value.parse().map_err(|<span class="kw">_</span>| E::custom(<span class="string">&quot;short (3-letter) or full month names expected&quot;</span>))
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;de</span>&gt; de::Deserialize&lt;<span class="lifetime">&#39;de</span>&gt; <span class="kw">for </span>Month {
<span class="kw">fn </span>deserialize&lt;D&gt;(deserializer: D) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, D::Error&gt;
<span class="kw">where
</span>D: de::Deserializer&lt;<span class="lifetime">&#39;de</span>&gt;,
{
deserializer.deserialize_str(MonthVisitor)
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serde_serialize() {
<span class="kw">use </span>serde_json::to_string;
<span class="kw">use </span>Month::<span class="kw-2">*</span>;
<span class="kw">let </span>cases: Vec&lt;(Month, <span class="kw-2">&amp;</span>str)&gt; = <span class="macro">vec!</span>[
(January, <span class="string">&quot;\&quot;January\&quot;&quot;</span>),
(February, <span class="string">&quot;\&quot;February\&quot;&quot;</span>),
(March, <span class="string">&quot;\&quot;March\&quot;&quot;</span>),
(April, <span class="string">&quot;\&quot;April\&quot;&quot;</span>),
(May, <span class="string">&quot;\&quot;May\&quot;&quot;</span>),
(June, <span class="string">&quot;\&quot;June\&quot;&quot;</span>),
(July, <span class="string">&quot;\&quot;July\&quot;&quot;</span>),
(August, <span class="string">&quot;\&quot;August\&quot;&quot;</span>),
(September, <span class="string">&quot;\&quot;September\&quot;&quot;</span>),
(October, <span class="string">&quot;\&quot;October\&quot;&quot;</span>),
(November, <span class="string">&quot;\&quot;November\&quot;&quot;</span>),
(December, <span class="string">&quot;\&quot;December\&quot;&quot;</span>),
];
<span class="kw">for </span>(month, expected_str) <span class="kw">in </span>cases {
<span class="kw">let </span>string = to_string(<span class="kw-2">&amp;</span>month).unwrap();
<span class="macro">assert_eq!</span>(string, expected_str);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_serde_deserialize() {
<span class="kw">use </span>serde_json::from_str;
<span class="kw">use </span>Month::<span class="kw-2">*</span>;
<span class="kw">let </span>cases: Vec&lt;(<span class="kw-2">&amp;</span>str, Month)&gt; = <span class="macro">vec!</span>[
(<span class="string">&quot;\&quot;january\&quot;&quot;</span>, January),
(<span class="string">&quot;\&quot;jan\&quot;&quot;</span>, January),
(<span class="string">&quot;\&quot;FeB\&quot;&quot;</span>, February),
(<span class="string">&quot;\&quot;MAR\&quot;&quot;</span>, March),
(<span class="string">&quot;\&quot;mar\&quot;&quot;</span>, March),
(<span class="string">&quot;\&quot;april\&quot;&quot;</span>, April),
(<span class="string">&quot;\&quot;may\&quot;&quot;</span>, May),
(<span class="string">&quot;\&quot;june\&quot;&quot;</span>, June),
(<span class="string">&quot;\&quot;JULY\&quot;&quot;</span>, July),
(<span class="string">&quot;\&quot;august\&quot;&quot;</span>, August),
(<span class="string">&quot;\&quot;september\&quot;&quot;</span>, September),
(<span class="string">&quot;\&quot;October\&quot;&quot;</span>, October),
(<span class="string">&quot;\&quot;November\&quot;&quot;</span>, November),
(<span class="string">&quot;\&quot;DECEmbEr\&quot;&quot;</span>, December),
];
<span class="kw">for </span>(string, expected_month) <span class="kw">in </span>cases {
<span class="kw">let </span>month = from_str::&lt;Month&gt;(string).unwrap();
<span class="macro">assert_eq!</span>(month, expected_month);
}
<span class="kw">let </span>errors: Vec&lt;<span class="kw-2">&amp;</span>str&gt; =
<span class="macro">vec!</span>[<span class="string">&quot;\&quot;not a month\&quot;&quot;</span>, <span class="string">&quot;\&quot;ja\&quot;&quot;</span>, <span class="string">&quot;\&quot;Dece\&quot;&quot;</span>, <span class="string">&quot;Dec&quot;</span>, <span class="string">&quot;\&quot;Augustin\&quot;&quot;</span>];
<span class="kw">for </span>string <span class="kw">in </span>errors {
from_str::&lt;Month&gt;(string).unwrap_err();
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::Month;
<span class="kw">use crate</span>::{Datelike, OutOfRange, TimeZone, Utc};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_month_enum_try_from() {
<span class="macro">assert_eq!</span>(Month::try_from(<span class="number">1</span>), <span class="prelude-val">Ok</span>(Month::January));
<span class="macro">assert_eq!</span>(Month::try_from(<span class="number">2</span>), <span class="prelude-val">Ok</span>(Month::February));
<span class="macro">assert_eq!</span>(Month::try_from(<span class="number">12</span>), <span class="prelude-val">Ok</span>(Month::December));
<span class="macro">assert_eq!</span>(Month::try_from(<span class="number">13</span>), <span class="prelude-val">Err</span>(OutOfRange::new()));
<span class="kw">let </span>date = Utc.with_ymd_and_hms(<span class="number">2019</span>, <span class="number">10</span>, <span class="number">28</span>, <span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>).unwrap();
<span class="macro">assert_eq!</span>(Month::try_from(date.month() <span class="kw">as </span>u8), <span class="prelude-val">Ok</span>(Month::October));
<span class="kw">let </span>month = Month::January;
<span class="kw">let </span>dt = Utc.with_ymd_and_hms(<span class="number">2019</span>, month.number_from_month(), <span class="number">28</span>, <span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>).unwrap();
<span class="macro">assert_eq!</span>((dt.year(), dt.month(), dt.day()), (<span class="number">2019</span>, <span class="number">1</span>, <span class="number">28</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_month_enum_primitive_parse() {
<span class="kw">use </span>num_traits::FromPrimitive;
<span class="kw">let </span>jan_opt = Month::from_u32(<span class="number">1</span>);
<span class="kw">let </span>feb_opt = Month::from_u64(<span class="number">2</span>);
<span class="kw">let </span>dec_opt = Month::from_i64(<span class="number">12</span>);
<span class="kw">let </span>no_month = Month::from_u32(<span class="number">13</span>);
<span class="macro">assert_eq!</span>(jan_opt, <span class="prelude-val">Some</span>(Month::January));
<span class="macro">assert_eq!</span>(feb_opt, <span class="prelude-val">Some</span>(Month::February));
<span class="macro">assert_eq!</span>(dec_opt, <span class="prelude-val">Some</span>(Month::December));
<span class="macro">assert_eq!</span>(no_month, <span class="prelude-val">None</span>);
<span class="kw">let </span>date = Utc.with_ymd_and_hms(<span class="number">2019</span>, <span class="number">10</span>, <span class="number">28</span>, <span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>).unwrap();
<span class="macro">assert_eq!</span>(Month::from_u32(date.month()), <span class="prelude-val">Some</span>(Month::October));
<span class="kw">let </span>month = Month::January;
<span class="kw">let </span>dt = Utc.with_ymd_and_hms(<span class="number">2019</span>, month.number_from_month(), <span class="number">28</span>, <span class="number">9</span>, <span class="number">10</span>, <span class="number">11</span>).unwrap();
<span class="macro">assert_eq!</span>((dt.year(), dt.month(), dt.day()), (<span class="number">2019</span>, <span class="number">1</span>, <span class="number">28</span>));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_month_enum_succ_pred() {
<span class="macro">assert_eq!</span>(Month::January.succ(), Month::February);
<span class="macro">assert_eq!</span>(Month::December.succ(), Month::January);
<span class="macro">assert_eq!</span>(Month::January.pred(), Month::December);
<span class="macro">assert_eq!</span>(Month::February.pred(), Month::January);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_month_partial_ord() {
<span class="macro">assert!</span>(Month::January &lt;= Month::January);
<span class="macro">assert!</span>(Month::January &lt; Month::February);
<span class="macro">assert!</span>(Month::January &lt; Month::December);
<span class="macro">assert!</span>(Month::July &gt;= Month::May);
<span class="macro">assert!</span>(Month::September &gt; Month::March);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="chrono" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>