Files
google-apis-rs/chrono/offset/index.html
2024-03-05 21:06:01 +01:00

18 lines
7.0 KiB
HTML
Raw 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="The time zone, which calculates offsets from the local time to UTC."><title>chrono::offset - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="chrono" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../chrono/index.html">chrono</a><span class="version">0.4.31</span></h2></div><h2 class="location"><a href="#">Module offset</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section><h2><a href="../index.html">In crate chrono</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../chrono/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">chrono</a>::<wbr><a class="mod" href="#">offset</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/chrono/offset/mod.rs.html#4-601">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The time zone, which calculates offsets from the local time to UTC.</p>
<p>There are four operations provided by the <code>TimeZone</code> trait:</p>
<ol>
<li>Converting the local <code>NaiveDateTime</code> to <code>DateTime&lt;Tz&gt;</code></li>
<li>Converting the UTC <code>NaiveDateTime</code> to <code>DateTime&lt;Tz&gt;</code></li>
<li>Converting <code>DateTime&lt;Tz&gt;</code> to the local <code>NaiveDateTime</code></li>
<li>Constructing <code>DateTime&lt;Tz&gt;</code> objects from various offsets</li>
</ol>
<p>1 is used for constructors. 2 is used for the <code>with_timezone</code> method of date and time types.
3 is used for other methods, e.g. <code>year()</code> or <code>format()</code>, and provided by an associated type
which implements <code>Offset</code> (which then passed to <code>TimeZone</code> for actual implementations).
Technically speaking <code>TimeZone</code> has a total knowledge about given timescale,
but <code>Offset</code> is used as a cache to avoid the repeated conversion
and provides implementations for 1 and 3.
An <code>TimeZone</code> instance can be reconstructed from the corresponding <code>Offset</code> instance.</p>
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FixedOffset.html" title="struct chrono::offset::FixedOffset">FixedOffset</a></div><div class="desc docblock-short">The time zone with fixed offset, from UTC-23:59:59 to UTC+23:59:59.</div></li><li><div class="item-name"><a class="struct" href="struct.Local.html" title="struct chrono::offset::Local">Local</a></div><div class="desc docblock-short">The local timescale. This is implemented via the standard <code>time</code> crate.</div></li><li><div class="item-name"><a class="struct" href="struct.Utc.html" title="struct chrono::offset::Utc">Utc</a></div><div class="desc docblock-short">The UTC time zone. This is the most efficient time zone when you dont need the local time.
It is also used as an offset (which is also a dummy type).</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.LocalResult.html" title="enum chrono::offset::LocalResult">LocalResult</a></div><div class="desc docblock-short">The conversion result from the local time to the timezone-aware datetime types.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Offset.html" title="trait chrono::offset::Offset">Offset</a></div><div class="desc docblock-short">The offset from the local time to UTC.</div></li><li><div class="item-name"><a class="trait" href="trait.TimeZone.html" title="trait chrono::offset::TimeZone">TimeZone</a></div><div class="desc docblock-short">The time zone.</div></li></ul></section></div></main></body></html>