pnmixer-rust/time/index.html
2017-07-15 01:30:16 +02:00

272 lines
13 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 `time` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, time">
<title>time - 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">
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</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">
<a href='../time/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Crate time</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'time', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>time</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/time/lib.rs.html#11-1277' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Simple time handling.</p>
<h1 id='usage' class='section-header'><a href='#usage'>Usage</a></h1>
<p>This crate is <a href="https://crates.io/crates/time">on crates.io</a> and can be
used by adding <code>time</code> to the dependencies in your project&#39;s <code>Cargo.toml</code>.</p>
<pre><code class="language-toml">[dependencies]
time = &quot;0.1&quot;
</code></pre>
<p>And this in your crate root:</p>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">time</span>;</pre>
<p>This crate uses the same syntax for format strings as the <a href="http://man7.org/linux/man-pages/man3/strftime.3.html">strftime()</a> function from the C
standard library.</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.Duration.html"
title='struct time::Duration'>Duration</a></td>
<td class='docblock-short'>
<p>ISO 8601 time duration with nanosecond precision.
This also allows for the negative duration; see individual methods for details.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.OutOfRangeError.html"
title='struct time::OutOfRangeError'>OutOfRangeError</a></td>
<td class='docblock-short'>
<p>Represents error when converting <code>Duration</code> to/from a standard library
implementation</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.PreciseTime.html"
title='struct time::PreciseTime'>PreciseTime</a></td>
<td class='docblock-short'>
<p>An opaque structure representing a moment in time.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SteadyTime.html"
title='struct time::SteadyTime'>SteadyTime</a></td>
<td class='docblock-short'>
<p>A structure representing a moment in time.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Timespec.html"
title='struct time::Timespec'>Timespec</a></td>
<td class='docblock-short'>
<p>A record specifying a time value in seconds and nanoseconds, where
nanoseconds represent the offset from the given second.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Tm.html"
title='struct time::Tm'>Tm</a></td>
<td class='docblock-short'>
<p>Holds a calendar date and time broken down into its components (year, month,
day, and so on), also called a broken-down time value.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.TmFmt.html"
title='struct time::TmFmt'>TmFmt</a></td>
<td class='docblock-short'>
<p>A wrapper around a <code>Tm</code> and format string that implements Display.</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.ParseError.html"
title='enum time::ParseError'>ParseError</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.at.html"
title='fn time::at'>at</a></td>
<td class='docblock-short'>
<p>Returns the specified time in the local timezone</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.at_utc.html"
title='fn time::at_utc'>at_utc</a></td>
<td class='docblock-short'>
<p>Returns the specified time in UTC</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.empty_tm.html"
title='fn time::empty_tm'>empty_tm</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_time.html"
title='fn time::get_time'>get_time</a></td>
<td class='docblock-short'>
<p>Returns the current time as a <code>timespec</code> containing the seconds and
nanoseconds since 1970-01-01T00:00:00Z.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.now.html"
title='fn time::now'>now</a></td>
<td class='docblock-short'>
<p>Returns the current time in the local timezone</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.now_utc.html"
title='fn time::now_utc'>now_utc</a></td>
<td class='docblock-short'>
<p>Returns the current time in UTC</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.precise_time_ns.html"
title='fn time::precise_time_ns'>precise_time_ns</a></td>
<td class='docblock-short'>
<p>Returns the current value of a high-resolution performance counter
in nanoseconds since an unspecified epoch.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.precise_time_s.html"
title='fn time::precise_time_s'>precise_time_s</a></td>
<td class='docblock-short'>
<p>Returns the current value of a high-resolution performance counter
in seconds since an unspecified epoch.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.strftime.html"
title='fn time::strftime'>strftime</a></td>
<td class='docblock-short'>
<p>Formats the time according to the format string.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.strptime.html"
title='fn time::strptime'>strptime</a></td>
<td class='docblock-short'>
<p>Parses the time from the string according to the format string.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.tzset.html"
title='fn time::tzset'>tzset</a></td>
<td class='docblock-short'>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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 = "time";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>