blob: 162db8272e4c27fc32d60d140e2935d18642c0a5 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/chrono-0.4.26/src/offset/utc.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>utc.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../chrono/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../chrono/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
</pre><pre class="rust"><code><span class="comment">// This is a part of Chrono.
// See README.md and LICENSE.txt for details.
</span><span class="doccomment">//! The UTC (Coordinated Universal Time) time zone.
</span><span class="kw">use </span>core::fmt;
<span class="attribute">#[cfg(all(
feature = <span class="string">&quot;clock&quot;</span>,
not(all(
target_arch = <span class="string">&quot;wasm32&quot;</span>,
feature = <span class="string">&quot;wasmbind&quot;</span>,
not(any(target_os = <span class="string">&quot;emscripten&quot;</span>, target_os = <span class="string">&quot;wasi&quot;</span>))
))
))]
</span><span class="kw">use </span>std::time::{SystemTime, UNIX_EPOCH};
<span class="attribute">#[cfg(feature = <span class="string">&quot;rkyv&quot;</span>)]
</span><span class="kw">use </span>rkyv::{Archive, Deserialize, Serialize};
<span class="kw">use super</span>::{FixedOffset, LocalResult, Offset, TimeZone};
<span class="kw">use </span><span class="kw">crate</span>::naive::{NaiveDate, NaiveDateTime};
<span class="attribute">#[cfg(feature = <span class="string">&quot;clock&quot;</span>)]
#[allow(deprecated)]
</span><span class="kw">use crate</span>::{Date, DateTime};
<span class="doccomment">/// The UTC time zone. This is the most efficient time zone when you don&#39;t need the local time.
/// It is also used as an offset (which is also a dummy type).
///
/// Using the [`TimeZone`](./trait.TimeZone.html) methods
/// on the UTC struct is the preferred way to construct `DateTime&lt;Utc&gt;`
/// instances.
///
/// # Example
///
/// ```
/// use chrono::{DateTime, TimeZone, NaiveDateTime, Utc};
///
/// let dt = DateTime::&lt;Utc&gt;::from_utc(NaiveDateTime::from_timestamp_opt(61, 0).unwrap(), Utc);
///
/// assert_eq!(Utc.timestamp_opt(61, 0).unwrap(), dt);
/// assert_eq!(Utc.with_ymd_and_hms(1970, 1, 1, 0, 1, 1).unwrap(), dt);
/// ```
</span><span class="attribute">#[derive(Copy, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = <span class="string">&quot;rkyv&quot;</span>, derive(Archive, Deserialize, Serialize))]
#[cfg_attr(feature = <span class="string">&quot;arbitrary&quot;</span>, derive(arbitrary::Arbitrary))]
</span><span class="kw">pub struct </span>Utc;
<span class="attribute">#[cfg(feature = <span class="string">&quot;clock&quot;</span>)]
#[cfg_attr(docsrs, doc(cfg(feature = <span class="string">&quot;clock&quot;</span>)))]
</span><span class="kw">impl </span>Utc {
<span class="doccomment">/// Returns a `Date` which corresponds to the current date.
</span><span class="attribute">#[deprecated(
since = <span class="string">&quot;0.4.23&quot;</span>,
note = <span class="string">&quot;use `Utc::now()` instead, potentially with `.date_naive()`&quot;
</span>)]
#[allow(deprecated)]
#[must_use]
</span><span class="kw">pub fn </span>today() -&gt; Date&lt;Utc&gt; {
Utc::now().date()
}
<span class="doccomment">/// Returns a `DateTime` which corresponds to the current date and time.
</span><span class="attribute">#[cfg(not(all(
target_arch = <span class="string">&quot;wasm32&quot;</span>,
feature = <span class="string">&quot;wasmbind&quot;</span>,
not(any(target_os = <span class="string">&quot;emscripten&quot;</span>, target_os = <span class="string">&quot;wasi&quot;</span>))
)))]
#[must_use]
</span><span class="kw">pub fn </span>now() -&gt; DateTime&lt;Utc&gt; {
<span class="kw">let </span>now =
SystemTime::now().duration_since(UNIX_EPOCH).expect(<span class="string">&quot;system time before Unix epoch&quot;</span>);
<span class="kw">let </span>naive =
NaiveDateTime::from_timestamp_opt(now.as_secs() <span class="kw">as </span>i64, now.subsec_nanos()).unwrap();
DateTime::from_utc(naive, Utc)
}
<span class="doccomment">/// Returns a `DateTime` which corresponds to the current date and time.
</span><span class="attribute">#[cfg(all(
target_arch = <span class="string">&quot;wasm32&quot;</span>,
feature = <span class="string">&quot;wasmbind&quot;</span>,
not(any(target_os = <span class="string">&quot;emscripten&quot;</span>, target_os = <span class="string">&quot;wasi&quot;</span>))
))]
#[must_use]
</span><span class="kw">pub fn </span>now() -&gt; DateTime&lt;Utc&gt; {
<span class="kw">let </span>now = js_sys::Date::new_0();
DateTime::&lt;Utc&gt;::from(now)
}
}
<span class="kw">impl </span>TimeZone <span class="kw">for </span>Utc {
<span class="kw">type </span>Offset = Utc;
<span class="kw">fn </span>from_offset(_state: <span class="kw-2">&amp;</span>Utc) -&gt; Utc {
Utc
}
<span class="kw">fn </span>offset_from_local_date(<span class="kw-2">&amp;</span><span class="self">self</span>, _local: <span class="kw-2">&amp;</span>NaiveDate) -&gt; LocalResult&lt;Utc&gt; {
LocalResult::Single(Utc)
}
<span class="kw">fn </span>offset_from_local_datetime(<span class="kw-2">&amp;</span><span class="self">self</span>, _local: <span class="kw-2">&amp;</span>NaiveDateTime) -&gt; LocalResult&lt;Utc&gt; {
LocalResult::Single(Utc)
}
<span class="kw">fn </span>offset_from_utc_date(<span class="kw-2">&amp;</span><span class="self">self</span>, _utc: <span class="kw-2">&amp;</span>NaiveDate) -&gt; Utc {
Utc
}
<span class="kw">fn </span>offset_from_utc_datetime(<span class="kw-2">&amp;</span><span class="self">self</span>, _utc: <span class="kw-2">&amp;</span>NaiveDateTime) -&gt; Utc {
Utc
}
}
<span class="kw">impl </span>Offset <span class="kw">for </span>Utc {
<span class="kw">fn </span>fix(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; FixedOffset {
FixedOffset::east_opt(<span class="number">0</span>).unwrap()
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Utc {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;Z&quot;</span>)
}
}
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Utc {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;UTC&quot;</span>)
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="chrono" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>