mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-17 16:29:50 +00:00
46 lines
No EOL
6.2 KiB
HTML
46 lines
No EOL
6.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 a receiver that delivers messages periodically."><title>tick in crossbeam_channel - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="crossbeam_channel" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../crossbeam_channel/index.html">crossbeam_<wbr>channel</a><span class="version">0.5.13</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">tick</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate crossbeam_<wbr>channel</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">crossbeam_channel</a></span><h1>Function <span class="fn">tick</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/crossbeam_channel/channel.rs.html#324-334">Source</a> </span></div><pre class="rust item-decl"><code>pub fn tick(duration: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>) -> <a class="struct" href="struct.Receiver.html" title="struct crossbeam_channel::Receiver">Receiver</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a receiver that delivers messages periodically.</p>
|
|
<p>The channel is bounded with capacity of 1 and never gets disconnected. Messages will be
|
|
sent into the channel in intervals of <code>duration</code>. Each message is the instant at which it is
|
|
sent.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Using a <code>tick</code> channel to periodically print elapsed time:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::time::{Duration, Instant};
|
|
<span class="kw">use </span>crossbeam_channel::tick;
|
|
|
|
<span class="kw">let </span>start = Instant::now();
|
|
<span class="kw">let </span>ticker = tick(Duration::from_millis(<span class="number">100</span>));
|
|
|
|
<span class="kw">for _ in </span><span class="number">0</span>..<span class="number">5 </span>{
|
|
ticker.recv().unwrap();
|
|
<span class="macro">println!</span>(<span class="string">"elapsed: {:?}"</span>, start.elapsed());
|
|
}</code></pre></div>
|
|
<p>When messages get sent:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::thread;
|
|
<span class="kw">use </span>std::time::{Duration, Instant};
|
|
<span class="kw">use </span>crossbeam_channel::tick;
|
|
|
|
<span class="comment">// Converts a number of milliseconds into a `Duration`.
|
|
</span><span class="kw">let </span>ms = |ms| Duration::from_millis(ms);
|
|
|
|
<span class="comment">// Returns `true` if `a` and `b` are very close `Instant`s.
|
|
</span><span class="kw">let </span>eq = |a, b| a + ms(<span class="number">65</span>) > b && b + ms(<span class="number">65</span>) > a;
|
|
|
|
<span class="kw">let </span>start = Instant::now();
|
|
<span class="kw">let </span>r = tick(ms(<span class="number">100</span>));
|
|
|
|
<span class="comment">// This message was sent 100 ms from the start and received 100 ms from the start.
|
|
</span><span class="macro">assert!</span>(eq(r.recv().unwrap(), start + ms(<span class="number">100</span>)));
|
|
<span class="macro">assert!</span>(eq(Instant::now(), start + ms(<span class="number">100</span>)));
|
|
|
|
thread::sleep(ms(<span class="number">500</span>));
|
|
|
|
<span class="comment">// This message was sent 200 ms from the start and received 600 ms from the start.
|
|
</span><span class="macro">assert!</span>(eq(r.recv().unwrap(), start + ms(<span class="number">200</span>)));
|
|
<span class="macro">assert!</span>(eq(Instant::now(), start + ms(<span class="number">600</span>)));
|
|
|
|
<span class="comment">// This message was sent 700 ms from the start and received 700 ms from the start.
|
|
</span><span class="macro">assert!</span>(eq(r.recv().unwrap(), start + ms(<span class="number">700</span>)));
|
|
<span class="macro">assert!</span>(eq(Instant::now(), start + ms(<span class="number">700</span>)));</code></pre></div>
|
|
</div></details></section></div></main></body></html> |