mentat/chrono/offset/index.html
2018-08-22 17:04:13 +00:00

194 lines
No EOL
8.8 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="API documentation for the Rust `offset` mod in crate `chrono`.">
<meta name="keywords" content="rust, rustlang, rust-lang, offset">
<title>chrono::offset - 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 mod">
<!--[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'>Module offset</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>chrono</a></p><script>window.sidebarCurrent = {name: 'offset', ty: 'mod', 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'>Module <a href='../index.html'>chrono</a>::<wbr><a class="mod" href=''>offset</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/offset/mod.rs.html#4-419' title='goto source code'>[src]</a></span></h1>
<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><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.FixedOffset.html"
title='struct chrono::offset::FixedOffset'>FixedOffset</a></td>
<td class='docblock-short'>
<p>The time zone with fixed offset, from UTC-23:59:59 to UTC+23:59:59.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Local.html"
title='struct chrono::offset::Local'>Local</a></td>
<td class='docblock-short'>
<p>The local timescale. This is implemented via the standard <code>time</code> crate.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Utc.html"
title='struct chrono::offset::Utc'>Utc</a></td>
<td class='docblock-short'>
<p>The UTC time zone. This is the most efficient time zone when you don't need the local time.
It is also used as an offset (which is also a dummy type).</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.LocalResult.html"
title='enum chrono::offset::LocalResult'>LocalResult</a></td>
<td class='docblock-short'>
<p>The conversion result from the local time to the timezone-aware datetime types.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Offset.html"
title='trait chrono::offset::Offset'>Offset</a></td>
<td class='docblock-short'>
<p>The offset from the local time to UTC.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.TimeZone.html"
title='trait chrono::offset::TimeZone'>TimeZone</a></td>
<td class='docblock-short'>
<p>The time zone.</p>
</td>
</tr></table></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>