| <!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/naive/isoweek.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>isoweek.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> |
| </pre><pre class="rust"><code><span class="comment">// This is a part of Chrono. |
| // See README.md and LICENSE.txt for details. |
| |
| </span><span class="doccomment">//! ISO 8601 week. |
| |
| </span><span class="kw">use </span>core::fmt; |
| |
| <span class="kw">use </span><span class="kw">super</span>::internals::{DateImpl, Of, YearFlags}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rkyv"</span>)] |
| </span><span class="kw">use </span>rkyv::{Archive, Deserialize, Serialize}; |
| |
| <span class="doccomment">/// ISO 8601 week. |
| /// |
| /// This type, combined with [`Weekday`](../enum.Weekday.html), |
| /// constitutes the ISO 8601 [week date](./struct.NaiveDate.html#week-date). |
| /// One can retrieve this type from the existing [`Datelike`](../trait.Datelike.html) types |
| /// via the [`Datelike::iso_week`](../trait.Datelike.html#tymethod.iso_week) method. |
| </span><span class="attribute">#[derive(PartialEq, Eq, PartialOrd, Ord, Copy, Clone, Hash)] |
| #[cfg_attr(feature = <span class="string">"rkyv"</span>, derive(Archive, Deserialize, Serialize))] |
| </span><span class="kw">pub struct </span>IsoWeek { |
| <span class="comment">// note that this allows for larger year range than `NaiveDate`. |
| // this is crucial because we have an edge case for the first and last week supported, |
| // which year number might not match the calendar year number. |
| </span>ywf: DateImpl, <span class="comment">// (year << 10) | (week << 4) | flag |
| </span>} |
| |
| <span class="doccomment">/// Returns the corresponding `IsoWeek` from the year and the `Of` internal value. |
| </span><span class="comment">// |
| // internal use only. we don't expose the public constructor for `IsoWeek` for now, |
| // because the year range for the week date and the calendar date do not match and |
| // it is confusing to have a date that is out of range in one and not in another. |
| // currently we sidestep this issue by making `IsoWeek` fully dependent of `Datelike`. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>iso_week_from_yof(year: i32, of: Of) -> IsoWeek { |
| <span class="kw">let </span>(rawweek, <span class="kw">_</span>) = of.isoweekdate_raw(); |
| <span class="kw">let </span>(year, week) = <span class="kw">if </span>rawweek < <span class="number">1 </span>{ |
| <span class="comment">// previous year |
| </span><span class="kw">let </span>prevlastweek = YearFlags::from_year(year - <span class="number">1</span>).nisoweeks(); |
| (year - <span class="number">1</span>, prevlastweek) |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span>lastweek = of.flags().nisoweeks(); |
| <span class="kw">if </span>rawweek > lastweek { |
| <span class="comment">// next year |
| </span>(year + <span class="number">1</span>, <span class="number">1</span>) |
| } <span class="kw">else </span>{ |
| (year, rawweek) |
| } |
| }; |
| <span class="kw">let </span>flags = YearFlags::from_year(year); |
| IsoWeek { ywf: (year << <span class="number">10</span>) | (week << <span class="number">4</span>) <span class="kw">as </span>DateImpl | DateImpl::from(flags.<span class="number">0</span>) } |
| } |
| |
| <span class="kw">impl </span>IsoWeek { |
| <span class="doccomment">/// Returns the year number for this ISO week. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use chrono::{NaiveDate, Datelike, Weekday}; |
| /// |
| /// let d = NaiveDate::from_isoywd_opt(2015, 1, Weekday::Mon).unwrap(); |
| /// assert_eq!(d.iso_week().year(), 2015); |
| /// ``` |
| /// |
| /// This year number might not match the calendar year number. |
| /// Continuing the example... |
| /// |
| /// ``` |
| /// # use chrono::{NaiveDate, Datelike, Weekday}; |
| /// # let d = NaiveDate::from_isoywd_opt(2015, 1, Weekday::Mon).unwrap(); |
| /// assert_eq!(d.year(), 2014); |
| /// assert_eq!(d, NaiveDate::from_ymd_opt(2014, 12, 29).unwrap()); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>year(<span class="kw-2">&</span><span class="self">self</span>) -> i32 { |
| <span class="self">self</span>.ywf >> <span class="number">10 |
| </span>} |
| |
| <span class="doccomment">/// Returns the ISO week number starting from 1. |
| /// |
| /// The return value ranges from 1 to 53. (The last week of year differs by years.) |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use chrono::{NaiveDate, Datelike, Weekday}; |
| /// |
| /// let d = NaiveDate::from_isoywd_opt(2015, 15, Weekday::Mon).unwrap(); |
| /// assert_eq!(d.iso_week().week(), 15); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>week(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| ((<span class="self">self</span>.ywf >> <span class="number">4</span>) & <span class="number">0x3f</span>) <span class="kw">as </span>u32 |
| } |
| |
| <span class="doccomment">/// Returns the ISO week number starting from 0. |
| /// |
| /// The return value ranges from 0 to 52. (The last week of year differs by years.) |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use chrono::{NaiveDate, Datelike, Weekday}; |
| /// |
| /// let d = NaiveDate::from_isoywd_opt(2015, 15, Weekday::Mon).unwrap(); |
| /// assert_eq!(d.iso_week().week0(), 14); |
| /// ``` |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub const fn </span>week0(<span class="kw-2">&</span><span class="self">self</span>) -> u32 { |
| ((<span class="self">self</span>.ywf >> <span class="number">4</span>) & <span class="number">0x3f</span>) <span class="kw">as </span>u32 - <span class="number">1 |
| </span>} |
| } |
| |
| <span class="doccomment">/// The `Debug` output of the ISO week `w` is the same as |
| /// [`d.format("%G-W%V")`](../format/strftime/index.html) |
| /// where `d` is any `NaiveDate` value in that week. |
| /// |
| /// # Example |
| /// |
| /// ``` |
| /// use chrono::{NaiveDate, Datelike}; |
| /// |
| /// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(2015, 9, 5).unwrap().iso_week()), "2015-W36"); |
| /// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt( 0, 1, 3).unwrap().iso_week()), "0000-W01"); |
| /// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(9999, 12, 31).unwrap().iso_week()), "9999-W52"); |
| /// ``` |
| /// |
| /// ISO 8601 requires an explicit sign for years before 1 BCE or after 9999 CE. |
| /// |
| /// ``` |
| /// # use chrono::{NaiveDate, Datelike}; |
| /// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt( 0, 1, 2).unwrap().iso_week()), "-0001-W52"); |
| /// assert_eq!(format!("{:?}", NaiveDate::from_ymd_opt(10000, 12, 31).unwrap().iso_week()), "+10000-W52"); |
| /// ``` |
| </span><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>IsoWeek { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="kw">let </span>year = <span class="self">self</span>.year(); |
| <span class="kw">let </span>week = <span class="self">self</span>.week(); |
| <span class="kw">if </span>(<span class="number">0</span>..=<span class="number">9999</span>).contains(<span class="kw-2">&</span>year) { |
| <span class="macro">write!</span>(f, <span class="string">"{:04}-W{:02}"</span>, year, week) |
| } <span class="kw">else </span>{ |
| <span class="comment">// ISO 8601 requires the explicit sign for out-of-range years |
| </span><span class="macro">write!</span>(f, <span class="string">"{:+05}-W{:02}"</span>, year, week) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span><span class="kw">crate</span>::naive::{internals, NaiveDate}; |
| <span class="kw">use </span><span class="kw">crate</span>::Datelike; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_iso_week_extremes() { |
| <span class="kw">let </span>minweek = NaiveDate::MIN.iso_week(); |
| <span class="kw">let </span>maxweek = NaiveDate::MAX.iso_week(); |
| |
| <span class="macro">assert_eq!</span>(minweek.year(), internals::MIN_YEAR); |
| <span class="macro">assert_eq!</span>(minweek.week(), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(minweek.week0(), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, minweek), NaiveDate::MIN.format(<span class="string">"%G-W%V"</span>).to_string()); |
| |
| <span class="macro">assert_eq!</span>(maxweek.year(), internals::MAX_YEAR + <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(maxweek.week(), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(maxweek.week0(), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(<span class="macro">format!</span>(<span class="string">"{:?}"</span>, maxweek), NaiveDate::MAX.format(<span class="string">"%G-W%V"</span>).to_string()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_iso_week_equivalence_for_first_week() { |
| <span class="kw">let </span>monday = NaiveDate::from_ymd_opt(<span class="number">2024</span>, <span class="number">12</span>, <span class="number">30</span>).unwrap(); |
| <span class="kw">let </span>friday = NaiveDate::from_ymd_opt(<span class="number">2025</span>, <span class="number">1</span>, <span class="number">3</span>).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(monday.iso_week(), friday.iso_week()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_iso_week_equivalence_for_last_week() { |
| <span class="kw">let </span>monday = NaiveDate::from_ymd_opt(<span class="number">2026</span>, <span class="number">12</span>, <span class="number">28</span>).unwrap(); |
| <span class="kw">let </span>friday = NaiveDate::from_ymd_opt(<span class="number">2027</span>, <span class="number">1</span>, <span class="number">1</span>).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(monday.iso_week(), friday.iso_week()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_iso_week_ordering_for_first_week() { |
| <span class="kw">let </span>monday = NaiveDate::from_ymd_opt(<span class="number">2024</span>, <span class="number">12</span>, <span class="number">30</span>).unwrap(); |
| <span class="kw">let </span>friday = NaiveDate::from_ymd_opt(<span class="number">2025</span>, <span class="number">1</span>, <span class="number">3</span>).unwrap(); |
| |
| <span class="macro">assert!</span>(monday.iso_week() >= friday.iso_week()); |
| <span class="macro">assert!</span>(monday.iso_week() <= friday.iso_week()); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_iso_week_ordering_for_last_week() { |
| <span class="kw">let </span>monday = NaiveDate::from_ymd_opt(<span class="number">2026</span>, <span class="number">12</span>, <span class="number">28</span>).unwrap(); |
| <span class="kw">let </span>friday = NaiveDate::from_ymd_opt(<span class="number">2027</span>, <span class="number">1</span>, <span class="number">1</span>).unwrap(); |
| |
| <span class="macro">assert!</span>(monday.iso_week() >= friday.iso_week()); |
| <span class="macro">assert!</span>(monday.iso_week() <= friday.iso_week()); |
| } |
| } |
| </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> |
