291 lines
42 KiB
HTML
291 lines
42 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 `TimeZone` trait in crate `chrono`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, TimeZone">
|
|||
|
|
|
|||
|
|
<title>chrono::offset::TimeZone - 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">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Trait TimeZone</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Offset">Offset</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_offset">from_offset</a><a href="#tymethod.offset_from_local_date">offset_from_local_date</a><a href="#tymethod.offset_from_local_datetime">offset_from_local_datetime</a><a href="#tymethod.offset_from_utc_date">offset_from_utc_date</a><a href="#tymethod.offset_from_utc_datetime">offset_from_utc_datetime</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.ymd">ymd</a><a href="#method.ymd_opt">ymd_opt</a><a href="#method.yo">yo</a><a href="#method.yo_opt">yo_opt</a><a href="#method.isoywd">isoywd</a><a href="#method.isoywd_opt">isoywd_opt</a><a href="#method.timestamp">timestamp</a><a href="#method.timestamp_opt">timestamp_opt</a><a href="#method.timestamp_millis">timestamp_millis</a><a href="#method.timestamp_millis_opt">timestamp_millis_opt</a><a href="#method.datetime_from_str">datetime_from_str</a><a href="#method.from_local_date">from_local_date</a><a href="#method.from_local_datetime">from_local_datetime</a><a href="#method.from_utc_date">from_utc_date</a><a href="#method.from_utc_datetime">from_utc_datetime</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>chrono</a>::<wbr><a href='index.html'>offset</a></p><script>window.sidebarCurrent = {name: 'TimeZone', 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 href='index.html'>offset</a>::<wbr><a class="trait" href=''>TimeZone</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/offset/mod.rs.html#164-409' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait TimeZone: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> {
|
|||
|
|
type <a href='#associatedtype.Offset' class="type">Offset</a>: <a class="trait" href="../../chrono/offset/trait.Offset.html" title="trait chrono::offset::Offset">Offset</a>;
|
|||
|
|
fn <a href='#tymethod.from_offset' class='fnname'>from_offset</a>(offset: &Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>) -> Self;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.offset_from_local_date' class='fnname'>offset_from_local_date</a>(<br> &self, <br> local: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.offset_from_local_datetime' class='fnname'>offset_from_local_datetime</a>(<br> &self, <br> local: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.offset_from_utc_date' class='fnname'>offset_from_utc_date</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>;
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.offset_from_utc_datetime' class='fnname'>offset_from_utc_datetime</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a>) -> Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>;
|
|||
|
|
|
|||
|
|
fn <a href='#method.ymd' class='fnname'>ymd</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.ymd_opt' class='fnname'>ymd_opt</a>(<br> &self, <br> year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.yo' class='fnname'>yo</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.yo_opt' class='fnname'>yo_opt</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.isoywd' class='fnname'>isoywd</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, week: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, weekday: <a class="enum" href="../../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.isoywd_opt' class='fnname'>isoywd_opt</a>(<br> &self, <br> year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> week: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> weekday: <a class="enum" href="../../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.timestamp' class='fnname'>timestamp</a>(&self, secs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, nsecs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.timestamp_opt' class='fnname'>timestamp_opt</a>(<br> &self, <br> secs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, <br> nsecs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.timestamp_millis' class='fnname'>timestamp_millis</a>(&self, millis: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.timestamp_millis_opt' class='fnname'>timestamp_millis_opt</a>(&self, millis: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.datetime_from_str' class='fnname'>datetime_from_str</a>(<br> &self, <br> s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> fmt: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a><br> ) -> <a class="type" href="../../chrono/format/type.ParseResult.html" title="type chrono::format::ParseResult">ParseResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.from_local_date' class='fnname'>from_local_date</a>(&self, local: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.from_local_datetime' class='fnname'>from_local_datetime</a>(<br> &self, <br> local: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a><br> ) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.from_utc_date' class='fnname'>from_utc_date</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self> { ... }
|
|||
|
|
<div class='item-spacer'></div> fn <a href='#method.from_utc_datetime' class='fnname'>from_utc_datetime</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self> { ... }
|
|||
|
|
}</pre><div class='docblock'><p>The time zone.</p>
|
|||
|
|
<p>The methods here are the primarily constructors for <a href="../struct.Date.html"><code>Date</code></a> and
|
|||
|
|
<a href="../struct.DateTime.html"><code>DateTime</code></a> types.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='associatedtype.Offset' class='method'><span id='Offset.t' class='invisible'><code>type <a href='#associatedtype.Offset' class="type">Offset</a>: <a class="trait" href="../../chrono/offset/trait.Offset.html" title="trait chrono::offset::Offset">Offset</a></code></span></h3><div class='docblock'><p>An associated offset type.
|
|||
|
|
This type is used to store the actual offset in date and time types.
|
|||
|
|
The original <code>TimeZone</code> value can be recovered via <code>TimeZone::from_offset</code>.</p>
|
|||
|
|
</div></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.from_offset' class='method'><span id='from_offset.v' class='invisible'><code>fn <a href='#tymethod.from_offset' class='fnname'>from_offset</a>(offset: &Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>) -> Self</code></span></h3><div class='docblock'><p>Reconstructs the time zone from the offset.</p>
|
|||
|
|
</div><h3 id='tymethod.offset_from_local_date' class='method'><span id='offset_from_local_date.v' class='invisible'><code>fn <a href='#tymethod.offset_from_local_date' class='fnname'>offset_from_local_date</a>(&self, local: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>></code></span></h3><div class='docblock'><p>Creates the offset(s) for given local <code>NaiveDate</code> if possible.</p>
|
|||
|
|
</div><h3 id='tymethod.offset_from_local_datetime' class='method'><span id='offset_from_local_datetime.v' class='invisible'><code>fn <a href='#tymethod.offset_from_local_datetime' class='fnname'>offset_from_local_datetime</a>(<br> &self, <br> local: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a><br>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a>></code></span></h3><div class='docblock'><p>Creates the offset(s) for given local <code>NaiveDateTime</code> if possible.</p>
|
|||
|
|
</div><h3 id='tymethod.offset_from_utc_date' class='method'><span id='offset_from_utc_date.v' class='invisible'><code>fn <a href='#tymethod.offset_from_utc_date' class='fnname'>offset_from_utc_date</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a></code></span></h3><div class='docblock'><p>Creates the offset for given UTC <code>NaiveDate</code>. This cannot fail.</p>
|
|||
|
|
</div><h3 id='tymethod.offset_from_utc_datetime' class='method'><span id='offset_from_utc_datetime.v' class='invisible'><code>fn <a href='#tymethod.offset_from_utc_datetime' class='fnname'>offset_from_utc_datetime</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a>) -> Self::<a class="type" href="../../chrono/offset/trait.TimeZone.html#associatedtype.Offset" title="type chrono::offset::TimeZone::Offset">Offset</a></code></span></h3><div class='docblock'><p>Creates the offset for given UTC <code>NaiveDateTime</code>. This cannot fail.</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.ymd' class='method'><span id='ymd.v' class='invisible'><code>fn <a href='#method.ymd' class='fnname'>ymd</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from year, month, day and the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Panics on the out-of-range date, invalid month and/or day.</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">Utc</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">ymd</span>(<span class="number">2015</span>, <span class="number">5</span>, <span class="number">15</span>).<span class="ident">to_string</span>(), <span class="string">"2015-05-15UTC"</span>);</pre>
|
|||
|
|
</div><h3 id='method.ymd_opt' class='method'><span id='ymd_opt.v' class='invisible'><code>fn <a href='#method.ymd_opt' class='fnname'>ymd_opt</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, month: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, day: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from year, month, day and the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Returns <code>None</code> on the out-of-range date, invalid month and/or day.</p>
|
|||
|
|
<h1 id="example-1" class="section-header"><a href="#example-1">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">LocalResult</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">ymd_opt</span>(<span class="number">2015</span>, <span class="number">5</span>, <span class="number">15</span>).<span class="ident">unwrap</span>().<span class="ident">to_string</span>(), <span class="string">"2015-05-15UTC"</span>);
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">ymd_opt</span>(<span class="number">2000</span>, <span class="number">0</span>, <span class="number">0</span>), <span class="ident">LocalResult</span>::<span class="prelude-val">None</span>);</pre>
|
|||
|
|
</div><h3 id='method.yo' class='method'><span id='yo.v' class='invisible'><code>fn <a href='#method.yo' class='fnname'>yo</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from year, day of year (DOY or "ordinal") and the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Panics on the out-of-range date and/or invalid DOY.</p>
|
|||
|
|
<h1 id="example-2" class="section-header"><a href="#example-2">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">yo</span>(<span class="number">2015</span>, <span class="number">135</span>).<span class="ident">to_string</span>(), <span class="string">"2015-05-15UTC"</span>);</pre>
|
|||
|
|
</div><h3 id='method.yo_opt' class='method'><span id='yo_opt.v' class='invisible'><code>fn <a href='#method.yo_opt' class='fnname'>yo_opt</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, ordinal: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from year, day of year (DOY or "ordinal") and the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Returns <code>None</code> on the out-of-range date and/or invalid DOY.</p>
|
|||
|
|
</div><h3 id='method.isoywd' class='method'><span id='isoywd.v' class='invisible'><code>fn <a href='#method.isoywd' class='fnname'>isoywd</a>(&self, year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, week: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, weekday: <a class="enum" href="../../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from ISO week date (year and week number), day of the week (DOW) and
|
|||
|
|
the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.
|
|||
|
|
The resulting <code>Date</code> may have a different year from the input year.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Panics on the out-of-range date and/or invalid week number.</p>
|
|||
|
|
<h1 id="example-3" class="section-header"><a href="#example-3">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">Weekday</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">isoywd</span>(<span class="number">2015</span>, <span class="number">20</span>, <span class="ident">Weekday</span>::<span class="ident">Fri</span>).<span class="ident">to_string</span>(), <span class="string">"2015-05-15UTC"</span>);</pre>
|
|||
|
|
</div><h3 id='method.isoywd_opt' class='method'><span id='isoywd_opt.v' class='invisible'><code>fn <a href='#method.isoywd_opt' class='fnname'>isoywd_opt</a>(<br> &self, <br> year: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> week: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> weekday: <a class="enum" href="../../chrono/enum.Weekday.html" title="enum chrono::Weekday">Weekday</a><br>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>></code></span></h3><div class='docblock'><p>Makes a new <code>Date</code> from ISO week date (year and week number), day of the week (DOW) and
|
|||
|
|
the current time zone.
|
|||
|
|
This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.
|
|||
|
|
The resulting <code>Date</code> may have a different year from the input year.</p>
|
|||
|
|
<p>The time zone normally does not affect the date (unless it is between UTC-24 and UTC+24),
|
|||
|
|
but it will propagate to the <code>DateTime</code> values constructed via this date.</p>
|
|||
|
|
<p>Returns <code>None</code> on the out-of-range date and/or invalid week number.</p>
|
|||
|
|
</div><h3 id='method.timestamp' class='method'><span id='timestamp.v' class='invisible'><code>fn <a href='#method.timestamp' class='fnname'>timestamp</a>(&self, secs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, nsecs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self></code></span></h3><div class='docblock'><p>Makes a new <code>DateTime</code> from the number of non-leap seconds
|
|||
|
|
since January 1, 1970 0:00:00 UTC (aka "UNIX timestamp")
|
|||
|
|
and the number of nanoseconds since the last whole non-leap second.</p>
|
|||
|
|
<p>Panics on the out-of-range number of seconds and/or invalid nanosecond,
|
|||
|
|
for a non-panicking version see <a href="#method.timestamp_opt"><code>timestamp_opt</code></a>.</p>
|
|||
|
|
<h1 id="example-4" class="section-header"><a href="#example-4">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">timestamp</span>(<span class="number">1431648000</span>, <span class="number">0</span>).<span class="ident">to_string</span>(), <span class="string">"2015-05-15 00:00:00 UTC"</span>);</pre>
|
|||
|
|
</div><h3 id='method.timestamp_opt' class='method'><span id='timestamp_opt.v' class='invisible'><code>fn <a href='#method.timestamp_opt' class='fnname'>timestamp_opt</a>(&self, secs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>, nsecs: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>></code></span></h3><div class='docblock'><p>Makes a new <code>DateTime</code> from the number of non-leap seconds
|
|||
|
|
since January 1, 1970 0:00:00 UTC (aka "UNIX timestamp")
|
|||
|
|
and the number of nanoseconds since the last whole non-leap second.</p>
|
|||
|
|
<p>Returns <code>LocalResult::None</code> on out-of-range number of seconds and/or
|
|||
|
|
invalid nanosecond, otherwise always returns <code>LocalResult::Single</code>.</p>
|
|||
|
|
</div><h3 id='method.timestamp_millis' class='method'><span id='timestamp_millis.v' class='invisible'><code>fn <a href='#method.timestamp_millis' class='fnname'>timestamp_millis</a>(&self, millis: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self></code></span></h3><div class='docblock'><p>Makes a new <code>DateTime</code> from the number of non-leap milliseconds
|
|||
|
|
since January 1, 1970 0:00:00 UTC (aka "UNIX timestamp").</p>
|
|||
|
|
<p>Panics on out-of-range number of milliseconds for a non-panicking
|
|||
|
|
version see <a href="#method.timestamp_millis_opt"><code>timestamp_millis_opt</code></a>.</p>
|
|||
|
|
<h1 id="example-5" class="section-header"><a href="#example-5">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">TimeZone</span>};
|
|||
|
|
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">Utc</span>.<span class="ident">timestamp_millis</span>(<span class="number">1431648000</span>).<span class="ident">timestamp</span>(), <span class="number">1431648</span>);</pre>
|
|||
|
|
</div><h3 id='method.timestamp_millis_opt' class='method'><span id='timestamp_millis_opt.v' class='invisible'><code>fn <a href='#method.timestamp_millis_opt' class='fnname'>timestamp_millis_opt</a>(&self, millis: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>></code></span></h3><div class='docblock'><p>Makes a new <code>DateTime</code> from the number of non-leap milliseconds
|
|||
|
|
since January 1, 1970 0:00:00 UTC (aka "UNIX timestamp").</p>
|
|||
|
|
<p>Returns <code>LocalResult::None</code> on out-of-range number of milliseconds
|
|||
|
|
and/or invalid nanosecond, otherwise always returns
|
|||
|
|
<code>LocalResult::Single</code>.</p>
|
|||
|
|
<h1 id="example-6" class="section-header"><a href="#example-6">Example</a></h1>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">chrono</span>::{<span class="ident">Utc</span>, <span class="ident">TimeZone</span>, <span class="ident">LocalResult</span>};
|
|||
|
|
<span class="kw">match</span> <span class="ident">Utc</span>.<span class="ident">timestamp_millis_opt</span>(<span class="number">1431648000</span>) {
|
|||
|
|
<span class="ident">LocalResult</span>::<span class="ident">Single</span>(<span class="ident">dt</span>) <span class="op">=></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">dt</span>.<span class="ident">timestamp</span>(), <span class="number">1431648</span>),
|
|||
|
|
_ <span class="op">=></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Incorrect timestamp_millis"</span>),
|
|||
|
|
};</pre>
|
|||
|
|
</div><h3 id='method.datetime_from_str' class='method'><span id='datetime_from_str.v' class='invisible'><code>fn <a href='#method.datetime_from_str' class='fnname'>datetime_from_str</a>(&self, s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, fmt: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../chrono/format/type.ParseResult.html" title="type chrono::format::ParseResult">ParseResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>></code></span></h3><div class='docblock'><p>Parses a string with the specified format string and
|
|||
|
|
returns a <code>DateTime</code> with the current offset.
|
|||
|
|
See the <a href="../format/strftime/index.html"><code>format::strftime</code> module</a>
|
|||
|
|
on the supported escape sequences.</p>
|
|||
|
|
<p>If the format does not include offsets, the current offset is assumed;
|
|||
|
|
otherwise the input should have a matching UTC offset.</p>
|
|||
|
|
<p>See also <code>DateTime::parse_from_str</code> which gives a local <code>DateTime</code>
|
|||
|
|
with parsed <code>FixedOffset</code>.</p>
|
|||
|
|
</div><h3 id='method.from_local_date' class='method'><span id='from_local_date.v' class='invisible'><code>fn <a href='#method.from_local_date' class='fnname'>from_local_date</a>(&self, local: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self>></code></span></h3><div class='docblock'><p>Converts the local <code>NaiveDate</code> to the timezone-aware <code>Date</code> if possible.</p>
|
|||
|
|
</div><h3 id='method.from_local_datetime' class='method'><span id='from_local_datetime.v' class='invisible'><code>fn <a href='#method.from_local_datetime' class='fnname'>from_local_datetime</a>(<br> &self, <br> local: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a><br>) -> <a class="enum" href="../../chrono/offset/enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a><<a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self>></code></span></h3><div class='docblock'><p>Converts the local <code>NaiveDateTime</code> to the timezone-aware <code>DateTime</code> if possible.</p>
|
|||
|
|
</div><h3 id='method.from_utc_date' class='method'><span id='from_utc_date.v' class='invisible'><code>fn <a href='#method.from_utc_date' class='fnname'>from_utc_date</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDate.html" title="struct chrono::naive::NaiveDate">NaiveDate</a>) -> <a class="struct" href="../../chrono/struct.Date.html" title="struct chrono::Date">Date</a><Self></code></span></h3><div class='docblock'><p>Converts the UTC <code>NaiveDate</code> to the local time.
|
|||
|
|
The UTC is continuous and thus this cannot fail (but can give the duplicate local time).</p>
|
|||
|
|
</div><h3 id='method.from_utc_datetime' class='method'><span id='from_utc_datetime.v' class='invisible'><code>fn <a href='#method.from_utc_datetime' class='fnname'>from_utc_datetime</a>(&self, utc: &<a class="struct" href="../../chrono/naive/struct.NaiveDateTime.html" title="struct chrono::naive::NaiveDateTime">NaiveDateTime</a>) -> <a class="struct" href="../../chrono/struct.DateTime.html" title="struct chrono::DateTime">DateTime</a><Self></code></span></h3><div class='docblock'><p>Converts the UTC <code>NaiveDateTime</code> to the local time.
|
|||
|
|
The UTC is continuous and thus this cannot fail (but can give the duplicate local time).</p>
|
|||
|
|
</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/offset/utc.rs.html#48-62' title='goto source code'>[src]</a></div><code>impl TimeZone for <a class="struct" href="../../chrono/offset/struct.Utc.html" title="struct chrono::offset::Utc">Utc</a><span class="where fmt-newline"> type <a href='#associatedtype.Offset' class="type">Offset</a> = <a class="struct" href="../../chrono/offset/struct.Utc.html" title="struct chrono::offset::Utc">Utc</a>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/chrono/offset/fixed.rs.html#99-113' title='goto source code'>[src]</a></div><code>impl TimeZone for <a class="struct" href="../../chrono/offset/struct.FixedOffset.html" title="struct chrono::offset::FixedOffset">FixedOffset</a><span class="where fmt-newline"> type <a href='#associatedtype.Offset' class="type">Offset</a> = <a class="struct" href="../../chrono/offset/struct.FixedOffset.html" title="struct chrono::offset::FixedOffset">FixedOffset</a>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/chrono/offset/local.rs.html#95-152' title='goto source code'>[src]</a></div><code>impl TimeZone for <a class="struct" href="../../chrono/offset/struct.Local.html" title="struct chrono::offset::Local">Local</a><span class="where fmt-newline"> type <a href='#associatedtype.Offset' class="type">Offset</a> = <a class="struct" href="../../chrono/offset/struct.FixedOffset.html" title="struct chrono::offset::FixedOffset">FixedOffset</a>;</span></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/chrono/offset/trait.TimeZone.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>⏎</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>
|