208 lines
No EOL
20 KiB
HTML
208 lines
No EOL
20 KiB
HTML
<!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" id="mainThemeStyle">
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
|
||
<script src="../../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Enum Numeric</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Year">Year</a><a href="#variant.YearDiv100">YearDiv100</a><a href="#variant.YearMod100">YearMod100</a><a href="#variant.IsoYear">IsoYear</a><a href="#variant.IsoYearDiv100">IsoYearDiv100</a><a href="#variant.IsoYearMod100">IsoYearMod100</a><a href="#variant.Month">Month</a><a href="#variant.Day">Day</a><a href="#variant.WeekFromSun">WeekFromSun</a><a href="#variant.WeekFromMon">WeekFromMon</a><a href="#variant.IsoWeek">IsoWeek</a><a href="#variant.NumDaysFromSun">NumDaysFromSun</a><a href="#variant.WeekdayFromMon">WeekdayFromMon</a><a href="#variant.Ordinal">Ordinal</a><a href="#variant.Hour">Hour</a><a href="#variant.Hour12">Hour12</a><a href="#variant.Minute">Minute</a><a href="#variant.Second">Second</a><a href="#variant.Nanosecond">Nanosecond</a><a href="#variant.Timestamp">Timestamp</a><a href="#variant.Internal">Internal</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-Debug">Debug</a></div></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></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../../theme.js"></script>
|
||
<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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/chrono/format/mod.rs.html#60-112' 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,
|
||
Internal(<a class="struct" href="../../chrono/format/struct.InternalNumeric.html" title="struct chrono::format::InternalNumeric">InternalNumeric</a>),
|
||
}</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 small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Year" class="variant small-section-header"><a href="#variant.Year" class="anchor field"></a><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 small-section-header"><a href="#variant.YearDiv100" class="anchor field"></a><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 small-section-header"><a href="#variant.YearMod100" class="anchor field"></a><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 small-section-header"><a href="#variant.IsoYear" class="anchor field"></a><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 small-section-header"><a href="#variant.IsoYearDiv100" class="anchor field"></a><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 small-section-header"><a href="#variant.IsoYearMod100" class="anchor field"></a><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 small-section-header"><a href="#variant.Month" class="anchor field"></a><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 small-section-header"><a href="#variant.Day" class="anchor field"></a><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 small-section-header"><a href="#variant.WeekFromSun" class="anchor field"></a><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 small-section-header"><a href="#variant.WeekFromMon" class="anchor field"></a><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 small-section-header"><a href="#variant.IsoWeek" class="anchor field"></a><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 small-section-header"><a href="#variant.NumDaysFromSun" class="anchor field"></a><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 small-section-header"><a href="#variant.WeekdayFromMon" class="anchor field"></a><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 small-section-header"><a href="#variant.Ordinal" class="anchor field"></a><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 small-section-header"><a href="#variant.Hour" class="anchor field"></a><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 small-section-header"><a href="#variant.Hour12" class="anchor field"></a><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 small-section-header"><a href="#variant.Minute" class="anchor field"></a><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 small-section-header"><a href="#variant.Second" class="anchor field"></a><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 small-section-header"><a href="#variant.Nanosecond" class="anchor field"></a><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 small-section-header"><a href="#variant.Timestamp" class="anchor field"></a><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><span id="variant.Internal" class="variant small-section-header"><a href="#variant.Internal" class="anchor field"></a><span id='Internal.v' class='invisible'><code>Internal(<a class="struct" href="../../chrono/format/struct.InternalNumeric.html" title="struct chrono::format::InternalNumeric">InternalNumeric</a>)</code></span></span><div class='docblock'><p>Internal uses only.</p>
|
||
<p>This item exists so that one can add additional internal-only formatting
|
||
without breaking major compatibility (as enum variants cannot be selectively private).</p>
|
||
</div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Clone' 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><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' 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>(&self) -> <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#59' title='goto source code'>[src]</a></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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></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 id='impl-PartialEq' 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><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' 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>(&self, __arg_0: &<a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' title='goto source code'>[src]</a></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>(&self, __arg_0: &<a class="enum" href="../../chrono/format/enum.Numeric.html" title="enum chrono::format::Numeric">Numeric</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 id='impl-Eq' 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><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'></div><h3 id='impl-Debug' 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><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/chrono/format/mod.rs.html#59' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></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><kbd>?</kbd></dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt><kbd>S</kbd></dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt><kbd>↑</kbd></dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt><kbd>↓</kbd></dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt><kbd>↹</kbd></dt>
|
||
<dd>Switch tab</dd>
|
||
<dt><kbd>⏎</kbd></dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt><kbd>+</kbd></dt>
|
||
<dd>Expand all sections</dd>
|
||
<dt><kbd>-</kbd></dt>
|
||
<dd>Collapse 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> |