mentat/chrono/trait.Datelike.html
2018-08-22 17:04:13 +00:00

207 lines
No EOL
23 KiB
HTML
Raw Permalink 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 `Datelike` trait in crate `chrono`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Datelike">
<title>chrono::Datelike - 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 trait">
<!--[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">&#9776;</div>
<p class='location'>Trait Datelike</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.year">year</a><a href="#tymethod.month">month</a><a href="#tymethod.month0">month0</a><a href="#tymethod.day">day</a><a href="#tymethod.day0">day0</a><a href="#tymethod.ordinal">ordinal</a><a href="#tymethod.ordinal0">ordinal0</a><a href="#tymethod.weekday">weekday</a><a href="#tymethod.iso_week">iso_week</a><a href="#tymethod.with_year">with_year</a><a href="#tymethod.with_month">with_month</a><a href="#tymethod.with_month0">with_month0</a><a href="#tymethod.with_day">with_day</a><a href="#tymethod.with_day0">with_day0</a><a href="#tymethod.with_ordinal">with_ordinal</a><a href="#tymethod.with_ordinal0">with_ordinal0</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.year_ce">year_ce</a><a href="#method.num_days_from_ce">num_days_from_ce</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>chrono</a></p><script>window.sidebarCurrent = {name: 'Datelike', ty: 'trait', 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'>Trait <a href='index.html'>chrono</a>::<wbr><a class="trait" href=''>Datelike</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/lib.rs.html#800-910' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Datelike: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
fn <a href='#tymethod.year' class='fnname'>year</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.month' class='fnname'>month</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.month0' class='fnname'>month0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.day' class='fnname'>day</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.day0' class='fnname'>day0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.ordinal' class='fnname'>ordinal</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.ordinal0' class='fnname'>ordinal0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.weekday' class='fnname'>weekday</a>(&amp;self) -&gt; <a class="enum" href="../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.iso_week' class='fnname'>iso_week</a>(&amp;self) -&gt; <a class="struct" href="../chrono/naive/struct.IsoWeek.html" title="struct chrono::naive::IsoWeek">IsoWeek</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_year' class='fnname'>with_year</a>(&amp;self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_month' class='fnname'>with_month</a>(&amp;self, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_month0' class='fnname'>with_month0</a>(&amp;self, month0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_day' class='fnname'>with_day</a>(&amp;self, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_day0' class='fnname'>with_day0</a>(&amp;self, day0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_ordinal' class='fnname'>with_ordinal</a>(&amp;self, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
<div class='item-spacer'></div> fn <a href='#tymethod.with_ordinal0' class='fnname'>with_ordinal0</a>(&amp;self, ordinal0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
fn <a href='#method.year_ce' class='fnname'>year_ce</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.num_days_from_ce' class='fnname'>num_days_from_ce</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a> { ... }
}</pre><div class='docblock'><p>The common set of methods for date component.</p>
</div>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.year' class='method'><span id='year.v' class='invisible'><code>fn <a href='#tymethod.year' class='fnname'>year</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></h3><div class='docblock'><p>Returns the year number in the <a href="./naive/struct.NaiveDate.html#calendar-date">calendar date</a>.</p>
</div><h3 id='tymethod.month' class='method'><span id='month.v' class='invisible'><code>fn <a href='#tymethod.month' class='fnname'>month</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the month number starting from 1.</p>
<p>The return value ranges from 1 to 12.</p>
</div><h3 id='tymethod.month0' class='method'><span id='month0.v' class='invisible'><code>fn <a href='#tymethod.month0' class='fnname'>month0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the month number starting from 0.</p>
<p>The return value ranges from 0 to 11.</p>
</div><h3 id='tymethod.day' class='method'><span id='day.v' class='invisible'><code>fn <a href='#tymethod.day' class='fnname'>day</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the day of month starting from 1.</p>
<p>The return value ranges from 1 to 31. (The last day of month differs by months.)</p>
</div><h3 id='tymethod.day0' class='method'><span id='day0.v' class='invisible'><code>fn <a href='#tymethod.day0' class='fnname'>day0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the day of month starting from 0.</p>
<p>The return value ranges from 0 to 30. (The last day of month differs by months.)</p>
</div><h3 id='tymethod.ordinal' class='method'><span id='ordinal.v' class='invisible'><code>fn <a href='#tymethod.ordinal' class='fnname'>ordinal</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the day of year starting from 1.</p>
<p>The return value ranges from 1 to 366. (The last day of year differs by years.)</p>
</div><h3 id='tymethod.ordinal0' class='method'><span id='ordinal0.v' class='invisible'><code>fn <a href='#tymethod.ordinal0' class='fnname'>ordinal0</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h3><div class='docblock'><p>Returns the day of year starting from 0.</p>
<p>The return value ranges from 0 to 365. (The last day of year differs by years.)</p>
</div><h3 id='tymethod.weekday' class='method'><span id='weekday.v' class='invisible'><code>fn <a href='#tymethod.weekday' class='fnname'>weekday</a>(&amp;self) -&gt; <a class="enum" href="../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a></code></span></h3><div class='docblock'><p>Returns the day of week.</p>
</div><h3 id='tymethod.iso_week' class='method'><span id='iso_week.v' class='invisible'><code>fn <a href='#tymethod.iso_week' class='fnname'>iso_week</a>(&amp;self) -&gt; <a class="struct" href="../chrono/naive/struct.IsoWeek.html" title="struct chrono::naive::IsoWeek">IsoWeek</a></code></span></h3><div class='docblock'><p>Returns the ISO week.</p>
</div><h3 id='tymethod.with_year' class='method'><span id='with_year.v' class='invisible'><code>fn <a href='#tymethod.with_year' class='fnname'>with_year</a>(&amp;self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the year number changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_month' class='method'><span id='with_month.v' class='invisible'><code>fn <a href='#tymethod.with_month' class='fnname'>with_month</a>(&amp;self, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the month number (starting from 1) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_month0' class='method'><span id='with_month0.v' class='invisible'><code>fn <a href='#tymethod.with_month0' class='fnname'>with_month0</a>(&amp;self, month0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the month number (starting from 0) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_day' class='method'><span id='with_day.v' class='invisible'><code>fn <a href='#tymethod.with_day' class='fnname'>with_day</a>(&amp;self, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the day of month (starting from 1) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_day0' class='method'><span id='with_day0.v' class='invisible'><code>fn <a href='#tymethod.with_day0' class='fnname'>with_day0</a>(&amp;self, day0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the day of month (starting from 0) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_ordinal' class='method'><span id='with_ordinal.v' class='invisible'><code>fn <a href='#tymethod.with_ordinal' class='fnname'>with_ordinal</a>(&amp;self, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the day of year (starting from 1) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div><h3 id='tymethod.with_ordinal0' class='method'><span id='with_ordinal0.v' class='invisible'><code>fn <a href='#tymethod.with_ordinal0' class='fnname'>with_ordinal0</a>(&amp;self, ordinal0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</code></span></h3><div class='docblock'><p>Makes a new value with the day of year (starting from 0) changed.</p>
<p>Returns <code>None</code> when the resulting value would be invalid.</p>
</div></div>
<h2 id='provided-methods' class='small-section-header'>
Provided Methods<a href='#provided-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='method.year_ce' class='method'><span id='year_ce.v' class='invisible'><code>fn <a href='#method.year_ce' class='fnname'>year_ce</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h3><div class='docblock'><p>Returns the absolute year number starting from 1 with a boolean flag,
which is false when the year predates the epoch (BCE/BC) and true otherwise (CE/AD).</p>
</div><h3 id='method.num_days_from_ce' class='method'><span id='num_days_from_ce.v' class='invisible'><code>fn <a href='#method.num_days_from_ce' class='fnname'>num_days_from_ce</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span></h3><div class='docblock'><p>Returns the number of days since January 1, Year 1 (aka Day 1) in the
proleptic Gregorian calendar.</p>
<h1 id="example" class="section-header"><a href="#example">Example:</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">NaiveDate</span>, <span class="ident">Datelike</span>};
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">NaiveDate</span>::<span class="ident">from_ymd</span>(<span class="number">1970</span>, <span class="number">1</span>, <span class="number">1</span>).<span class="ident">num_days_from_ce</span>(), <span class="number">719163</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">NaiveDate</span>::<span class="ident">from_ymd</span>(<span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>).<span class="ident">num_days_from_ce</span>(), <span class="op">-</span><span class="number">365</span>);</pre>
</div></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../src/chrono/naive/date.rs.html#963-1303' title='goto source code'>[src]</a></div><code>impl Datelike for <a class="struct" href="../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a></code></li>
<li><div class='out-of-band'><a class='srclink' href='../src/chrono/naive/datetime.rs.html#680-996' title='goto source code'>[src]</a></div><code>impl Datelike for <a class="struct" href="../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a></code></li>
<li><div class='out-of-band'><a class='srclink' href='../src/chrono/date.rs.html#273-318' title='goto source code'>[src]</a></div><code>impl&lt;Tz:&nbsp;<a class="trait" href="../chrono/offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>&gt; Datelike for <a class="struct" href="../chrono/struct.Date.html" title="struct chrono::Date">Date</a>&lt;Tz&gt;</code></li>
<li><div class='out-of-band'><a class='srclink' href='../src/chrono/datetime.rs.html#397-442' title='goto source code'>[src]</a></div><code>impl&lt;Tz:&nbsp;<a class="trait" href="../chrono/offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>&gt; Datelike for <a class="struct" href="../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a>&lt;Tz&gt;</code></li>
</ul><script type="text/javascript" async
src="../implementors/chrono/trait.Datelike.js">
</script></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>&#9166;</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>