147 lines
8.8 KiB
HTML
147 lines
8.8 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 `PreciseTime` struct in crate `time`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, PreciseTime">
|
|||
|
|
|
|||
|
|
<title>time::PreciseTime - 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 struct">
|
|||
|
|
<!--[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'>Struct PreciseTime</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>time</a></p><script>window.sidebarCurrent = {name: 'PreciseTime', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Struct <a href='index.html'>time</a>::<wbr><a class="struct" href=''>PreciseTime</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/time/lib.rs.html#194' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct PreciseTime(_);</pre><div class='docblock'><p>An opaque structure representing a moment in time.</p>
|
|||
|
|
|
|||
|
|
<p>The only operation that can be performed on a <code>PreciseTime</code> is the
|
|||
|
|
calculation of the <code>Duration</code> of time that lies between them.</p>
|
|||
|
|
|
|||
|
|
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
|||
|
|
<p>Repeatedly call a function for 1 second:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">time</span>::{<span class="ident">Duration</span>, <span class="ident">PreciseTime</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">start</span> <span class="op">=</span> <span class="ident">PreciseTime</span>::<span class="ident">now</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">while</span> <span class="ident">start</span>.<span class="ident">to</span>(<span class="ident">PreciseTime</span>::<span class="ident">now</span>()) <span class="op"><</span> <span class="ident">Duration</span>::<span class="ident">seconds</span>(<span class="number">1</span>) {
|
|||
|
|
<span class="ident">do_some_work</span>();
|
|||
|
|
}</pre>
|
|||
|
|
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/time/lib.rs.html#196-222' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.now' class="method"><span id='now.v' class='invisible'><code>fn <a href='#method.now' class='fnname'>now</a>() -> <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>PreciseTime</code> representing the current moment in time.</p>
|
|||
|
|
</div><h4 id='method.to' class="method"><span id='to.v' class='invisible'><code>fn <a href='#method.to' class='fnname'>to</a>(&self, later: <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a>) -> <a class="struct" href="../time/struct.Duration.html" title="struct time::Duration">Duration</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a <code>Duration</code> representing the span of time from the value of
|
|||
|
|
<code>self</code> to the value of <code>later</code>.</p>
|
|||
|
|
|
|||
|
|
<h1 id='notes' class='section-header'><a href='#notes'>Notes</a></h1>
|
|||
|
|
<p>If <code>later</code> represents a time before <code>self</code>, the result of this method
|
|||
|
|
is unspecified.</p>
|
|||
|
|
|
|||
|
|
<p>If <code>later</code> represents a time more than 293 years after <code>self</code>, the
|
|||
|
|
result of this method is unspecified.</p>
|
|||
|
|
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/time/lib.rs.html#193' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/time/lib.rs.html#193' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../time/struct.PreciseTime.html" title="struct time::PreciseTime">PreciseTime</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div></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>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</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>
|