220 lines
No EOL
9.8 KiB
HTML
220 lines
No EOL
9.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 `tokio_timer` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, tokio_timer">
|
||
|
||
<title>tokio_timer - 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">☰</div>
|
||
|
||
<p class='location'>Crate tokio_timer</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'tokio_timer', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>tokio_timer</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/tokio_timer/lib.rs.html#1-49' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Utilities for scheduling work to happen after a period of time.</p>
|
||
<p>This crate provides a number of utilities for working with periods of time:</p>
|
||
<ul>
|
||
<li>
|
||
<p><a href="struct.Delay.html"><code>Delay</code></a>: A future that completes at a specified instant in time.</p>
|
||
</li>
|
||
<li>
|
||
<p><a href="struct.Interval.html"><code>Interval</code></a> A stream that yields at fixed time intervals.</p>
|
||
</li>
|
||
<li>
|
||
<p><a href="struct.Deadline.html"><code>Deadline</code></a>: Wraps a future, requiring it to complete before a specified
|
||
instant in time, erroring if the future takes too long.</p>
|
||
</li>
|
||
</ul>
|
||
<p>These three types are backed by a <a href="timer/struct.Timer.html"><code>Timer</code></a> instance. In order for
|
||
<a href="struct.Delay.html"><code>Delay</code></a>, <a href="struct.Interval.html"><code>Interval</code></a>, and <a href="struct.Deadline.html"><code>Deadline</code></a> to function, the associated
|
||
<a href="timer/struct.Timer.html"><code>Timer</code></a> instance must be running on some thread.</p>
|
||
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
||
<table><tr><td><code>pub use self::timer::<a class="struct" href="../tokio_timer/timer/struct.Timer.html" title="struct tokio_timer::timer::Timer">Timer</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="clock/index.html"
|
||
title='mod tokio_timer::clock'>clock</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A configurable source of time.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="mod" href="timer/index.html"
|
||
title='mod tokio_timer::timer'>timer</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Timer implementation.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Deadline.html"
|
||
title='struct tokio_timer::Deadline'>Deadline</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Allows a given <code>Future</code> to execute until the specified deadline.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.DeadlineError.html"
|
||
title='struct tokio_timer::DeadlineError'>DeadlineError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error returned by <code>Deadline</code> future.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Delay.html"
|
||
title='struct tokio_timer::Delay'>Delay</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A future that completes at a specified instant in time.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Error.html"
|
||
title='struct tokio_timer::Error'>Error</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Errors encountered by the timer implementation.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Interval.html"
|
||
title='struct tokio_timer::Interval'>Interval</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A stream representing notifications at fixed interval</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.sleep.html"
|
||
title='fn tokio_timer::sleep'>sleep</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create a Future that completes in <code>duration</code> from now.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.with_default.html"
|
||
title='fn tokio_timer::with_default'>with_default</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Set the default timer for the duration of the closure.</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>⏎</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 = "tokio_timer";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |