51 lines
9.2 KiB
HTML
51 lines
9.2 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="Creates new [`Interval`] that yields with interval of `period`. The first tick completes immediately. The default [`MissedTickBehavior`] is `Burst`, but this can be configured by calling `set_missed_tick_behavior`."><meta name="keywords" content="rust, rustlang, rust-lang, interval"><title>interval in tokio::time - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="../index.html">tokio</a>::<wbr><a href="index.html">time</a></h2><div id="sidebar-vars" data-name="interval" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../tokio/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><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><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></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/time/interval.rs.html#74-77" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust fn"><code>pub fn interval(period: <a class="struct" href="https://doc.rust-lang.org/1.59.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="struct.Interval.html" title="struct tokio::time::Interval">Interval</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates new <a href="struct.Interval.html" title="Interval"><code>Interval</code></a> that yields with interval of <code>period</code>. The first
|
||
tick completes immediately. The default <a href="enum.MissedTickBehavior.html" title="MissedTickBehavior"><code>MissedTickBehavior</code></a> is
|
||
<a href="enum.MissedTickBehavior.html#variant.Burst"><code>Burst</code></a>, but this can be configured
|
||
by calling <a href="struct.Interval.html#method.set_missed_tick_behavior"><code>set_missed_tick_behavior</code></a>.</p>
|
||
<p>An interval will tick indefinitely. At any time, the <a href="struct.Interval.html" title="Interval"><code>Interval</code></a> value can
|
||
be dropped. This cancels the interval.</p>
|
||
<p>This function is equivalent to
|
||
<a href="fn.interval_at.html"><code>interval_at(Instant::now(), period)</code></a>.</p>
|
||
<h2 id="panics" class="section-header"><a href="#panics">Panics</a></h2>
|
||
<p>This function panics if <code>period</code> is zero.</p>
|
||
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">tokio::time</span>::{<span class="self">self</span>, <span class="ident">Duration</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">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::interval</span>(<span class="ident">Duration::from_millis</span>(<span class="number">10</span>));
|
||
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="kw">await</span>; <span class="comment">// ticks immediately</span>
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="kw">await</span>; <span class="comment">// ticks after 10ms</span>
|
||
<span class="ident">interval</span>.<span class="ident">tick</span>().<span class="kw">await</span>; <span class="comment">// ticks after 10ms</span>
|
||
|
||
<span class="comment">// approximately 20ms have elapsed.</span>
|
||
}</code></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="fn.sleep.html"><code>sleep</code></a> is that an <a href="struct.Interval.html" title="Interval"><code>Interval</code></a>
|
||
measures the time since the last tick, which means that <a href="struct.Interval.html#method.tick"><code>.tick().await</code></a>
|
||
may wait for a shorter time than the duration specified for the interval
|
||
if some time has passed between calls to <a href="struct.Interval.html#method.tick"><code>.tick().await</code></a>.</p>
|
||
<p>If the tick in the example below was replaced with <a href="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"><code><span class="kw">use</span> <span class="ident">tokio::time</span>;
|
||
|
||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">task_that_takes_a_second</span>() {
|
||
<span class="macro">println!</span>(<span class="string">"hello"</span>);
|
||
<span class="ident">time::sleep</span>(<span class="ident">time::Duration::from_secs</span>(<span class="number">1</span>)).<span class="kw">await</span>
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">tokio::main</span>]</span>
|
||
<span class="kw">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::interval</span>(<span class="ident">time::Duration::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="kw">await</span>;
|
||
<span class="ident">task_that_takes_a_second</span>().<span class="kw">await</span>;
|
||
}
|
||
}</code></pre></div>
|
||
</div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |