50 lines
7.5 KiB
HTML
50 lines
7.5 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 `interval` fn in crate `tokio`."><meta name="keywords" content="rust, rustlang, rust-lang, interval"><title>tokio::time::interval - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">tokio</a>::<wbr><a href="index.html">time</a></p><script>window.sidebarCurrent = {name: "interval", ty: "fn", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><span class="help-button">?</span>
|
||
<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/time/interval.rs.html#67-71" title="goto source code">[src]</a></span><span class="in-band">Function <a href="../index.html">tokio</a>::<wbr><a href="index.html">time</a>::<wbr><a class="fn" href="">interval</a></span></h1><pre class="rust fn">pub fn interval(period: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="../../tokio/time/struct.Interval.html" title="struct tokio::time::Interval">Interval</a></pre><div class="docblock"><p>Creates new <code>Interval</code> that yields with interval of <code>duration</code>. The first
|
||
tick completes immediately.</p>
|
||
<p>An interval will tick indefinitely. At any time, the <code>Interval</code> value can be
|
||
dropped. This cancels the interval.</p>
|
||
<p>This function is equivalent to <code>interval_at(Instant::now(), period)</code>.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>This function panics if <code>period</code> is zero.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">time</span>::{<span class="self">self</span>, <span class="ident">Duration</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">interval</span> <span class="op">=</span> <span class="ident">time</span>::<span class="ident">interval</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">10</span>));
|
||
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="ident">await</span>;
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="ident">await</span>;
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="ident">await</span>;
|
||
|
||
<span class="comment">// approximately 20ms have elapsed.</span>
|
||
}</pre></div>
|
||
<p>A simple example using <code>interval</code> to execute a task every two seconds.</p>
|
||
<p>The difference between <code>interval</code> and <a href="../../tokio/time/fn.sleep.html"><code>sleep</code></a> is that an <code>interval</code>
|
||
measures the time since the last tick, which means that <code>.tick().await</code>
|
||
may wait for a shorter time than the duration specified for the interval
|
||
if some time has passed between calls to <code>.tick().await</code>.</p>
|
||
<p>If the tick in the example below was replaced with <a href="../../tokio/time/fn.sleep.html"><code>sleep</code></a>, the task
|
||
would only be executed once every three seconds, and not every two
|
||
seconds.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tokio</span>::<span class="ident">time</span>;
|
||
|
||
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">task_that_takes_a_second</span>() {
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"hello"</span>);
|
||
<span class="ident">time</span>::<span class="ident">sleep</span>(<span class="ident">time</span>::<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">1</span>)).<span class="ident">await</span>
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">tokio</span>::<span class="ident">main</span>]</span>
|
||
<span class="ident">async</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">interval</span> <span class="op">=</span> <span class="ident">time</span>::<span class="ident">interval</span>(<span class="ident">time</span>::<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">2</span>));
|
||
<span class="kw">for</span> <span class="ident">_i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">5</span> {
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="ident">await</span>;
|
||
<span class="ident">task_that_takes_a_second</span>().<span class="ident">await</span>;
|
||
}
|
||
}</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "tokio";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |