18 lines
5.6 KiB
HTML
18 lines
5.6 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 `clock` mod in crate `tokio_timer`."><meta name="keywords" content="rust, rustlang, rust-lang, clock"><title>tokio_timer::clock - 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="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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">☰</div><a href='../../tokio_timer/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module clock</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>tokio_timer</a></p><script>window.sidebarCurrent = {name: 'clock', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/tokio_timer/clock/mod.rs.html#1-23' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>tokio_timer</a>::<wbr><a class="mod" href=''>clock</a></span></h1><div class='docblock'><p>A configurable source of time.</p>
|
||
<p>This module provides an API to get the current instant in such a way that
|
||
the source of time may be configured. This allows mocking out the source of
|
||
time in tests.</p>
|
||
<p>The <a href="fn.now.html"><code>now</code></a> function returns the current <a href="https://doc.rust-lang.org/std/time/struct.Instant.html"><code>Instant</code></a>. By default, it delegates
|
||
to <a href="https://doc.rust-lang.org/std/time/struct.Instant.html#method.now"><code>Instant::now</code></a>.</p>
|
||
<p>The source of time used by <a href="fn.now.html"><code>now</code></a> can be configured by implementing the
|
||
<a href="trait.Now.html"><code>Now</code></a> trait and passing an instance to <a href="fn.with_default.html"><code>with_default</code></a>.</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.Clock.html" title='tokio_timer::clock::Clock struct'>Clock</a></td><td class='docblock-short'><p>A handle to a source of time.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DefaultGuard.html" title='tokio_timer::clock::DefaultGuard struct'>DefaultGuard</a></td><td class='docblock-short'><p>A guard that resets the current <code>Clock</code> to <code>None</code> when dropped.</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.Now.html" title='tokio_timer::clock::Now trait'>Now</a></td><td class='docblock-short'><p>Returns <a href="https://doc.rust-lang.org/std/time/struct.Instant.html"><code>Instant</code></a> values representing the current instant in time.</p>
|
||
</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.now.html" title='tokio_timer::clock::now fn'>now</a></td><td class='docblock-short'><p>Returns an <code>Instant</code> corresponding to "now".</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.set_default.html" title='tokio_timer::clock::set_default fn'>set_default</a></td><td class='docblock-short'><p>Sets <code>clock</code> as the default clock, returning a guard that unsets it on drop.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.with_default.html" title='tokio_timer::clock::with_default fn'>with_default</a></td><td class='docblock-short'><p>Set the default clock for the duration of the closure.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tokio_timer";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |