mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 02:30:43 +00:00
31 lines
6.4 KiB
HTML
31 lines
6.4 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 `async` fn in crate `chan`."><meta name="keywords" content="rust, rustlang, rust-lang, async"><title>chan::async - 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></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><div class="sidebar-elems"><p class='location'><a href='index.html'>chan</a></p><script>window.sidebarCurrent = {name: 'async', 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!"><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"><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='in-band'>Function <a href='index.html'>chan</a>::<wbr><a class="fn" href=''>async</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/chan/lib.rs.html#523-527' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn async<T>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../chan/struct.Sender.html" title="struct chan::Sender">Sender</a><T>, <a class="struct" href="../chan/struct.Receiver.html" title="struct chan::Receiver">Receiver</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></pre><div class='docblock'><p>Create an asynchronous channel with an unbounded buffer.</p>
|
||
<p>Since the buffer is unbounded, send operations always succeed immediately.</p>
|
||
<p>Receive operations succeed only when there is at least one value in the
|
||
buffer.</p>
|
||
<p>Values are guaranteed to be received in the same order that they are sent.</p>
|
||
<p>The send and receive values returned can be cloned arbitrarily (i.e.,
|
||
multi-producer/multi-consumer) and moved to other threads.</p>
|
||
<p>When all senders are dropped, the channel is closed automatically. No
|
||
more values may be sent on a closed channel. Once a channel is closed and
|
||
the buffer is empty, all receive operations return <code>None</code> immediately.
|
||
(If a channel is closed and there are still values in the buffer, then
|
||
receive operations will retrieve those first.)</p>
|
||
<p>When all receivers are dropped, no special action is taken. When the buffer
|
||
is full, all subsequent send operations will block indefinitely.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<p>Asynchronous channels are nice when you just want to enqueue a bunch
|
||
of values up front:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> (<span class="ident">s</span>, <span class="ident">r</span>) <span class="op">=</span> <span class="ident">chan</span>::<span class="ident">async</span>();
|
||
|
||
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> {
|
||
<span class="ident">s</span>.<span class="ident">send</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="ident">drop</span>(<span class="ident">s</span>); <span class="comment">// closing the channel lets the iterator stop</span>
|
||
<span class="kw">let</span> <span class="ident">numbers</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="ident">r</span>.<span class="ident">iter</span>().<span class="ident">collect</span>();
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">numbers</span>, (<span class="number">0</span>..<span class="number">10</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">i32</span><span class="op">>></span>());</pre>
|
||
<p>(Others should help me come up with more compelling examples of
|
||
asynchronous channels.)</p>
|
||
</div></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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "chan";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |