194 lines
20 KiB
HTML
194 lines
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 `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">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
|
|||
|
|
<p class='location'>Trait Datelike</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></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>
|
|||
|
|
</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'>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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/chrono/lib.rs.html#544-646' 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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>;
|
|||
|
|
fn <a href='#tymethod.month' class='fnname'>month</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.month0' class='fnname'>month0</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.day' class='fnname'>day</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.day0' class='fnname'>day0</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.ordinal' class='fnname'>ordinal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.ordinal0' class='fnname'>ordinal0</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
|
|||
|
|
fn <a href='#tymethod.weekday' class='fnname'>weekday</a>(&self) -> <a class="enum" href="../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a>;
|
|||
|
|
fn <a href='#tymethod.isoweekdate' class='fnname'>isoweekdate</a>(&self) -> <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.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
|||
|
|
fn <a href='#tymethod.with_year' class='fnname'>with_year</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_month' class='fnname'>with_month</a>(&self, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_month0' class='fnname'>with_month0</a>(&self, month0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_day' class='fnname'>with_day</a>(&self, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_day0' class='fnname'>with_day0</a>(&self, day0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_ordinal' class='fnname'>with_ordinal</a>(&self, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
fn <a href='#tymethod.with_ordinal0' class='fnname'>with_ordinal0</a>(&self, ordinal0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self>;
|
|||
|
|
|
|||
|
|
fn <a href='#method.year_ce' class='fnname'>year_ce</a>(&self) -> <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> { ... }
|
|||
|
|
fn <a href='#method.num_days_from_ce' class='fnname'>num_days_from_ce</a>(&self) -> <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'>Required Methods</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>(&self) -> <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/date/index.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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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>(&self) -> <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.isoweekdate' class='method'><span id='isoweekdate.v' class='invisible'><code>fn <a href='#tymethod.isoweekdate' class='fnname'>isoweekdate</a>(&self) -> <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.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="enum" href="../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</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 ISO week date: an adjusted year, week number and day of week.
|
|||
|
|
The adjusted year may differ from that of the calendar date.</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>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, month0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, day0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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>(&self, ordinal0: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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'>Provided Methods</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>(&self) -> <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>(&self) -> <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, 1 (Day 1) in the proleptic Gregorian calendar.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors'>Implementors</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><code>impl Datelike for <a class="struct" href="../chrono/naive/date/struct.NaiveDate.html" title="struct chrono::naive::date::NaiveDate">NaiveDate</a></code></li>
|
|||
|
|
<li><code>impl Datelike for <a class="struct" href="../chrono/naive/datetime/struct.NaiveDateTime.html" title="struct chrono::naive::datetime::NaiveDateTime">NaiveDateTime</a></code></li>
|
|||
|
|
<li><code>impl<Tz: <a class="trait" href="../chrono/offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>> Datelike for <a class="struct" href="../chrono/date/struct.Date.html" title="struct chrono::date::Date">Date</a><Tz></code></li>
|
|||
|
|
<li><code>impl<Tz: <a class="trait" href="../chrono/offset/trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a>> Datelike for <a class="struct" href="../chrono/datetime/struct.DateTime.html" title="struct chrono::datetime::DateTime">DateTime</a><Tz></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>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</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>
|