| <!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/modifier.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>modifier.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> |
| <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> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Various modifiers for components. |
| |
| </span><span class="kw">use </span>core::num::NonZeroU16; |
| |
| <span class="comment">// region: date modifiers |
| </span><span class="doccomment">/// Day of the month. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Day { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// The representation of a month. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>MonthRepr { |
| <span class="doccomment">/// The number of the month (January is 1, December is 12). |
| </span>Numerical, |
| <span class="doccomment">/// The long form of the month name (e.g. "January"). |
| </span>Long, |
| <span class="doccomment">/// The short form of the month name (e.g. "Jan"). |
| </span>Short, |
| } |
| |
| <span class="doccomment">/// Month of the year. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Month { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| <span class="doccomment">/// What form of representation should be used? |
| </span><span class="kw">pub </span>repr: MonthRepr, |
| <span class="doccomment">/// Is the value case sensitive when parsing? |
| </span><span class="kw">pub </span>case_sensitive: bool, |
| } |
| |
| <span class="doccomment">/// Ordinal day of the year. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Ordinal { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// The representation used for the day of the week. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>WeekdayRepr { |
| <span class="doccomment">/// The short form of the weekday (e.g. "Mon"). |
| </span>Short, |
| <span class="doccomment">/// The long form of the weekday (e.g. "Monday"). |
| </span>Long, |
| <span class="doccomment">/// A numerical representation using Sunday as the first day of the week. |
| /// |
| /// Sunday is either 0 or 1, depending on the other modifier's value. |
| </span>Sunday, |
| <span class="doccomment">/// A numerical representation using Monday as the first day of the week. |
| /// |
| /// Monday is either 0 or 1, depending on the other modifier's value. |
| </span>Monday, |
| } |
| |
| <span class="doccomment">/// Day of the week. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Weekday { |
| <span class="doccomment">/// What form of representation should be used? |
| </span><span class="kw">pub </span>repr: WeekdayRepr, |
| <span class="doccomment">/// When using a numerical representation, should it be zero or one-indexed? |
| </span><span class="kw">pub </span>one_indexed: bool, |
| <span class="doccomment">/// Is the value case sensitive when parsing? |
| </span><span class="kw">pub </span>case_sensitive: bool, |
| } |
| |
| <span class="doccomment">/// The representation used for the week number. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>WeekNumberRepr { |
| <span class="doccomment">/// Week 1 is the week that contains January 4. |
| </span>Iso, |
| <span class="doccomment">/// Week 1 begins on the first Sunday of the calendar year. |
| </span>Sunday, |
| <span class="doccomment">/// Week 1 begins on the first Monday of the calendar year. |
| </span>Monday, |
| } |
| |
| <span class="doccomment">/// Week within the year. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>WeekNumber { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| <span class="doccomment">/// What kind of representation should be used? |
| </span><span class="kw">pub </span>repr: WeekNumberRepr, |
| } |
| |
| <span class="doccomment">/// The representation used for a year value. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>YearRepr { |
| <span class="doccomment">/// The full value of the year. |
| </span>Full, |
| <span class="doccomment">/// Only the last two digits of the year. |
| </span>LastTwo, |
| } |
| |
| <span class="doccomment">/// Year of the date. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Year { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| <span class="doccomment">/// What kind of representation should be used? |
| </span><span class="kw">pub </span>repr: YearRepr, |
| <span class="doccomment">/// Whether the value is based on the ISO week number or the Gregorian calendar. |
| </span><span class="kw">pub </span>iso_week_based: bool, |
| <span class="doccomment">/// Whether the `+` sign is present when a positive year contains fewer than five digits. |
| </span><span class="kw">pub </span>sign_is_mandatory: bool, |
| } |
| <span class="comment">// endregion date modifiers |
| |
| // region: time modifiers |
| </span><span class="doccomment">/// Hour of the day. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Hour { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| <span class="doccomment">/// Is the hour displayed using a 12 or 24-hour clock? |
| </span><span class="kw">pub </span>is_12_hour_clock: bool, |
| } |
| |
| <span class="doccomment">/// Minute within the hour. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Minute { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// AM/PM part of the time. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Period { |
| <span class="doccomment">/// Is the period uppercase or lowercase? |
| </span><span class="kw">pub </span>is_uppercase: bool, |
| <span class="doccomment">/// Is the value case sensitive when parsing? |
| /// |
| /// Note that when `false`, the `is_uppercase` field has no effect on parsing behavior. |
| </span><span class="kw">pub </span>case_sensitive: bool, |
| } |
| |
| <span class="doccomment">/// Second within the minute. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Second { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// The number of digits present in a subsecond representation. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>SubsecondDigits { |
| <span class="doccomment">/// Exactly one digit. |
| </span>One, |
| <span class="doccomment">/// Exactly two digits. |
| </span>Two, |
| <span class="doccomment">/// Exactly three digits. |
| </span>Three, |
| <span class="doccomment">/// Exactly four digits. |
| </span>Four, |
| <span class="doccomment">/// Exactly five digits. |
| </span>Five, |
| <span class="doccomment">/// Exactly six digits. |
| </span>Six, |
| <span class="doccomment">/// Exactly seven digits. |
| </span>Seven, |
| <span class="doccomment">/// Exactly eight digits. |
| </span>Eight, |
| <span class="doccomment">/// Exactly nine digits. |
| </span>Nine, |
| <span class="doccomment">/// Any number of digits (up to nine) that is at least one. When formatting, the minimum digits |
| /// necessary will be used. |
| </span>OneOrMore, |
| } |
| |
| <span class="doccomment">/// Subsecond within the second. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Subsecond { |
| <span class="doccomment">/// How many digits are present in the component? |
| </span><span class="kw">pub </span>digits: SubsecondDigits, |
| } |
| <span class="comment">// endregion time modifiers |
| |
| // region: offset modifiers |
| </span><span class="doccomment">/// Hour of the UTC offset. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>OffsetHour { |
| <span class="doccomment">/// Whether the `+` sign is present on positive values. |
| </span><span class="kw">pub </span>sign_is_mandatory: bool, |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// Minute within the hour of the UTC offset. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>OffsetMinute { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| |
| <span class="doccomment">/// Second within the minute of the UTC offset. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>OffsetSecond { |
| <span class="doccomment">/// The padding to obtain the minimum width. |
| </span><span class="kw">pub </span>padding: Padding, |
| } |
| <span class="comment">// endregion offset modifiers |
| |
| </span><span class="doccomment">/// Type of padding to ensure a minimum width. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>Padding { |
| <span class="doccomment">/// A space character (` `) should be used as padding. |
| </span>Space, |
| <span class="doccomment">/// A zero character (`0`) should be used as padding. |
| </span>Zero, |
| <span class="doccomment">/// There is no padding. This can result in a width below the otherwise minimum number of |
| /// characters. |
| </span><span class="prelude-val">None</span>, |
| } |
| |
| <span class="doccomment">/// Ignore some number of bytes. |
| /// |
| /// This has no effect when formatting. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>Ignore { |
| <span class="doccomment">/// The number of bytes to ignore. |
| </span><span class="kw">pub </span>count: NonZeroU16, |
| } |
| |
| <span class="comment">// Needed as `Default` is deliberately not implemented for `Ignore`. The number of bytes to ignore |
| // must be explicitly provided. |
| </span><span class="kw">impl </span>Ignore { |
| <span class="doccomment">/// Create an instance of `Ignore` with the provided number of bytes to ignore. |
| </span><span class="kw">pub const fn </span>count(count: NonZeroU16) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ count } |
| } |
| } |
| |
| <span class="doccomment">/// The precision of a Unix timestamp. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>UnixTimestampPrecision { |
| <span class="doccomment">/// Seconds since the Unix epoch. |
| </span>Second, |
| <span class="doccomment">/// Milliseconds since the Unix epoch. |
| </span>Millisecond, |
| <span class="doccomment">/// Microseconds since the Unix epoch. |
| </span>Microsecond, |
| <span class="doccomment">/// Nanoseconds since the Unix epoch. |
| </span>Nanosecond, |
| } |
| |
| <span class="doccomment">/// A Unix timestamp. |
| </span><span class="attribute">#[non_exhaustive] |
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] |
| </span><span class="kw">pub struct </span>UnixTimestamp { |
| <span class="doccomment">/// The precision of the timestamp. |
| </span><span class="kw">pub </span>precision: UnixTimestampPrecision, |
| <span class="doccomment">/// Whether the `+` sign must be present for a non-negative timestamp. |
| </span><span class="kw">pub </span>sign_is_mandatory: bool, |
| } |
| |
| <span class="doccomment">/// Generate the provided code if and only if `pub` is present. |
| </span><span class="macro">macro_rules! </span>if_pub { |
| (<span class="kw">pub </span>$(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>:meta]</span>)<span class="kw-2">*</span>; $(<span class="macro-nonterminal">$x</span>:tt)<span class="kw-2">*</span>) => { |
| $(<span class="attribute">#[<span class="macro-nonterminal">$attr</span>]</span>)* |
| <span class="doccomment">/// |
| /// This function exists since [`Default::default()`] cannot be used in a `const` context. |
| /// It may be removed once that becomes possible. As the [`Default`] trait is in the |
| /// prelude, removing this function in the future will not cause any resolution failures for |
| /// the overwhelming majority of users; only users who use `#![no_implicit_prelude]` will be |
| /// affected. As such it will not be considered a breaking change. |
| </span>$(<span class="macro-nonterminal">$x</span>)* |
| }; |
| ($(<span class="macro-nonterminal">$</span><span class="kw">_</span>:<span class="macro-nonterminal">tt</span>)<span class="kw-2">*</span>) => {}; |
| } |
| |
| <span class="doccomment">/// Implement `Default` for the given type. This also generates an inherent implementation of a |
| /// `default` method that is `const fn`, permitting the default value to be used in const contexts. |
| </span><span class="comment">// Every modifier should use this macro rather than a derived `Default`. |
| </span><span class="macro">macro_rules! </span>impl_const_default { |
| ($($(<span class="attribute">#[<span class="macro-nonterminal">$doc</span>:meta]</span>)* $(@<span class="macro-nonterminal">$</span><span class="kw">pub</span>:<span class="macro-nonterminal">ident</span>)<span class="question-mark">? </span><span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">ty </span>=> <span class="macro-nonterminal">$default</span>:expr;)<span class="kw-2">*</span>) => {$( |
| <span class="kw">impl </span><span class="macro-nonterminal">$</span><span class="kw">type </span>{ |
| <span class="macro">if_pub! </span>{ |
| $(<span class="macro-nonterminal">$</span><span class="kw">pub</span>)<span class="question-mark">? |
| </span>$(<span class="attribute">#[<span class="macro-nonterminal">$doc</span>]</span>)<span class="kw-2">*</span>; |
| <span class="kw">pub const fn </span>default() -> <span class="self">Self </span>{ |
| <span class="macro-nonterminal">$default |
| </span>} |
| } |
| } |
| |
| $(<span class="attribute">#[<span class="macro-nonterminal">$doc</span>]</span>)* |
| <span class="kw">impl </span>Default <span class="kw">for </span><span class="macro-nonterminal">$</span><span class="kw">type </span>{ |
| <span class="kw">fn </span><span class="macro-nonterminal">default</span>() -> <span class="self">Self </span>{ |
| <span class="macro-nonterminal">$default |
| </span>} |
| } |
| )<span class="kw-2">*</span>}; |
| } |
| |
| <span class="macro">impl_const_default! </span>{ |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>Day => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the |
| /// [`Numerical`](Self::Numerical) representation. |
| </span>MonthRepr => <span class="self">Self</span>::Numerical; |
| <span class="doccomment">/// Creates an instance of this type that indicates the value uses the |
| /// [`Numerical`](MonthRepr::Numerical) representation, is [padded with zeroes](Padding::Zero), |
| /// and is case-sensitive when parsing. |
| </span>@<span class="kw">pub </span>Month => <span class="self">Self </span>{ |
| padding: Padding::Zero, |
| repr: MonthRepr::Numerical, |
| case_sensitive: <span class="bool-val">true</span>, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>Ordinal => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the [`Long`](Self::Long) representation. |
| </span>WeekdayRepr => <span class="self">Self</span>::Long; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the [`Long`](WeekdayRepr::Long) |
| /// representation and is case-sensitive when parsing. If the representation is changed to a |
| /// numerical one, the instance defaults to one-based indexing. |
| </span>@<span class="kw">pub </span>Weekday => <span class="self">Self </span>{ |
| repr: WeekdayRepr::Long, |
| one_indexed: <span class="bool-val">true</span>, |
| case_sensitive: <span class="bool-val">true</span>, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates that the value uses the [`Iso`](Self::Iso) representation. |
| </span>WeekNumberRepr => <span class="self">Self</span>::Iso; |
| <span class="doccomment">/// Creates a modifier that indicates that the value is [padded with zeroes](Padding::Zero) |
| /// and uses the [`Iso`](WeekNumberRepr::Iso) representation. |
| </span>@<span class="kw">pub </span>WeekNumber => <span class="self">Self </span>{ |
| padding: Padding::Zero, |
| repr: WeekNumberRepr::Iso, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the [`Full`](Self::Full) representation. |
| </span>YearRepr => <span class="self">Self</span>::Full; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the [`Full`](YearRepr::Full) |
| /// representation, is [padded with zeroes](Padding::Zero), uses the Gregorian calendar as its |
| /// base, and only includes the year's sign if necessary. |
| </span>@<span class="kw">pub </span>Year => <span class="self">Self </span>{ |
| padding: Padding::Zero, |
| repr: YearRepr::Full, |
| iso_week_based: <span class="bool-val">false</span>, |
| sign_is_mandatory: <span class="bool-val">false</span>, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero) and |
| /// has the 24-hour representation. |
| </span>@<span class="kw">pub </span>Hour => <span class="self">Self </span>{ |
| padding: Padding::Zero, |
| is_12_hour_clock: <span class="bool-val">false</span>, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>Minute => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the upper-case representation and is |
| /// case-sensitive when parsing. |
| </span>@<span class="kw">pub </span>Period => <span class="self">Self </span>{ |
| is_uppercase: <span class="bool-val">true</span>, |
| case_sensitive: <span class="bool-val">true</span>, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>Second => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the stringified value contains [one or more |
| /// digits](Self::OneOrMore). |
| </span>SubsecondDigits => <span class="self">Self</span>::OneOrMore; |
| <span class="doccomment">/// Creates a modifier that indicates the stringified value contains [one or more |
| /// digits](SubsecondDigits::OneOrMore). |
| </span>@<span class="kw">pub </span>Subsecond => <span class="self">Self </span>{ digits: SubsecondDigits::OneOrMore }; |
| <span class="doccomment">/// Creates a modifier that indicates the value uses the `+` sign for all positive values |
| /// and is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>OffsetHour => <span class="self">Self </span>{ |
| sign_is_mandatory: <span class="bool-val">true</span>, |
| padding: Padding::Zero, |
| }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>OffsetMinute => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Padding::Zero). |
| </span>@<span class="kw">pub </span>OffsetSecond => <span class="self">Self </span>{ padding: Padding::Zero }; |
| <span class="doccomment">/// Creates a modifier that indicates the value is [padded with zeroes](Self::Zero). |
| </span>Padding => <span class="self">Self</span>::Zero; |
| <span class="doccomment">/// Creates a modifier that indicates the value represents the [number of seconds](Self::Second) |
| /// since the Unix epoch. |
| </span>UnixTimestampPrecision => <span class="self">Self</span>::Second; |
| <span class="doccomment">/// Creates a modifier that indicates the value represents the [number of |
| /// seconds](UnixTimestampPrecision::Second) since the Unix epoch. The sign is not mandatory. |
| </span>@<span class="kw">pub </span>UnixTimestamp => <span class="self">Self </span>{ |
| precision: UnixTimestampPrecision::Second, |
| sign_is_mandatory: <span class="bool-val">false</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> |
