pnmixer-rust/chrono/format/enum.Numeric.html

187 lines
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `Numeric` enum in crate `chrono`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Numeric">
<title>chrono::format::Numeric - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc enum">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Enum Numeric</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>chrono</a>::<wbr><a href='index.html'>format</a></p><script>window.sidebarCurrent = {name: 'Numeric', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>chrono</a>::<wbr><a href='index.html'>format</a>::<wbr><a class="enum" href=''>Numeric</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/chrono/format/mod.rs.html#46-92' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Numeric {
Year,
YearDiv100,
YearMod100,
IsoYear,
IsoYearDiv100,
IsoYearMod100,
Month,
Day,
WeekFromSun,
WeekFromMon,
IsoWeek,
NumDaysFromSun,
WeekdayFromMon,
Ordinal,
Hour,
Hour12,
Minute,
Second,
Nanosecond,
Timestamp,
}</pre><div class='docblock'><p>Numeric item types.
They have associated formatting width (FW) and parsing width (PW).</p>
<p>The <strong>formatting width</strong> is the minimal width to be formatted.
If the number is too short, and the padding is not <a href="./enum.Pad.html#variant.None"><code>Pad::None</code></a>,
then it is left-padded.
If the number is too long or (in some cases) negative, it is printed as is.</p>
<p>The <strong>parsing width</strong> is the maximal width to be scanned.
The parser only tries to consume from one to given number of digits (greedily).
It also trims the preceding whitespaces if any.
It cannot parse the negative number, so some date and time cannot be formatted then
parsed with the same formatting items.</p>
</div><h2 id='variants' class='variants'>Variants</h2>
<span id='variant.Year' class='variant'><span id='Year.v' class='invisible'><code>Year</code></span></span><div class='docblock'><p>Full Gregorian year (FW=4, PW=∞).
May accept years before 1 BCE or after 9999 CE, given an initial sign.</p>
</div><span id='variant.YearDiv100' class='variant'><span id='YearDiv100.v' class='invisible'><code>YearDiv100</code></span></span><div class='docblock'><p>Gregorian year divided by 100 (century number; FW=PW=2). Implies the non-negative year.</p>
</div><span id='variant.YearMod100' class='variant'><span id='YearMod100.v' class='invisible'><code>YearMod100</code></span></span><div class='docblock'><p>Gregorian year modulo 100 (FW=PW=2). Cannot be negative.</p>
</div><span id='variant.IsoYear' class='variant'><span id='IsoYear.v' class='invisible'><code>IsoYear</code></span></span><div class='docblock'><p>Year in the ISO week date (FW=4, PW=∞).
May accept years before 1 BCE or after 9999 CE, given an initial sign.</p>
</div><span id='variant.IsoYearDiv100' class='variant'><span id='IsoYearDiv100.v' class='invisible'><code>IsoYearDiv100</code></span></span><div class='docblock'><p>Year in the ISO week date, divided by 100 (FW=PW=2). Implies the non-negative year.</p>
</div><span id='variant.IsoYearMod100' class='variant'><span id='IsoYearMod100.v' class='invisible'><code>IsoYearMod100</code></span></span><div class='docblock'><p>Year in the ISO week date, modulo 100 (FW=PW=2). Cannot be negative.</p>
</div><span id='variant.Month' class='variant'><span id='Month.v' class='invisible'><code>Month</code></span></span><div class='docblock'><p>Month (FW=PW=2).</p>
</div><span id='variant.Day' class='variant'><span id='Day.v' class='invisible'><code>Day</code></span></span><div class='docblock'><p>Day of the month (FW=PW=2).</p>
</div><span id='variant.WeekFromSun' class='variant'><span id='WeekFromSun.v' class='invisible'><code>WeekFromSun</code></span></span><div class='docblock'><p>Week number, where the week 1 starts at the first Sunday of January (FW=PW=2).</p>
</div><span id='variant.WeekFromMon' class='variant'><span id='WeekFromMon.v' class='invisible'><code>WeekFromMon</code></span></span><div class='docblock'><p>Week number, where the week 1 starts at the first Monday of January (FW=PW=2).</p>
</div><span id='variant.IsoWeek' class='variant'><span id='IsoWeek.v' class='invisible'><code>IsoWeek</code></span></span><div class='docblock'><p>Week number in the ISO week date (FW=PW=2).</p>
</div><span id='variant.NumDaysFromSun' class='variant'><span id='NumDaysFromSun.v' class='invisible'><code>NumDaysFromSun</code></span></span><div class='docblock'><p>Day of the week, where Sunday = 0 and Saturday = 6 (FW=PW=1).</p>
</div><span id='variant.WeekdayFromMon' class='variant'><span id='WeekdayFromMon.v' class='invisible'><code>WeekdayFromMon</code></span></span><div class='docblock'><p>Day of the week, where Monday = 1 and Sunday = 7 (FW=PW=1).</p>
</div><span id='variant.Ordinal' class='variant'><span id='Ordinal.v' class='invisible'><code>Ordinal</code></span></span><div class='docblock'><p>Day of the year (FW=PW=3).</p>
</div><span id='variant.Hour' class='variant'><span id='Hour.v' class='invisible'><code>Hour</code></span></span><div class='docblock'><p>Hour number in the 24-hour clocks (FW=PW=2).</p>
</div><span id='variant.Hour12' class='variant'><span id='Hour12.v' class='invisible'><code>Hour12</code></span></span><div class='docblock'><p>Hour number in the 12-hour clocks (FW=PW=2).</p>
</div><span id='variant.Minute' class='variant'><span id='Minute.v' class='invisible'><code>Minute</code></span></span><div class='docblock'><p>The number of minutes since the last whole hour (FW=PW=2).</p>
</div><span id='variant.Second' class='variant'><span id='Second.v' class='invisible'><code>Second</code></span></span><div class='docblock'><p>The number of seconds since the last whole minute (FW=PW=2).</p>
</div><span id='variant.Nanosecond' class='variant'><span id='Nanosecond.v' class='invisible'><code>Nanosecond</code></span></span><div class='docblock'><p>The number of nanoseconds since the last whole second (FW=PW=9).
Note that this is <em>not</em> left-aligned;
see also <a href="./enum.Fixed.html#variant.Nanosecond"><code>Fixed::Nanosecond</code></a>.</p>
</div><span id='variant.Timestamp' class='variant'><span id='Timestamp.v' class='invisible'><code>Timestamp</code></span></span><div class='docblock'><p>The number of non-leap seconds since the midnight UTC on January 1, 1970 (FW=1, PW=∞).
For formatting, it assumes UTC upon the absence of time zone offset.</p>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "chrono";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>