mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 10:10:42 +00:00
162 lines
8.1 KiB
HTML
162 lines
8.1 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 `sync` fn in crate `chan`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, sync">
|
||
|
||
<title>chan::sync - 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: 'sync', 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">
|
||
</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=''>sync</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#477-481' title='goto source code'>[src]</a></span></h1><pre class='rust fn'>pub fn sync<T>(size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <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 a synchronous channel with a possibly empty buffer.</p>
|
||
<p>When the <code>size</code> is zero, the buffer is empty and the channel becomes a
|
||
rendezvous channel. A rendezvous channel blocks send operations until
|
||
a corresponding receive operation consumes the sent value.</p>
|
||
<p>When the <code>size</code> is non-zero, the send operations will only block when the
|
||
buffer is full. Send operations only unblock when a receive operation
|
||
removes an element from 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="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>An example of a rendezvous channel:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
||
|
||
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">chan</span>::<span class="ident">sync</span>(<span class="number">0</span>);
|
||
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> <span class="ident">send</span>.<span class="ident">send</span>(<span class="number">5</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">recv</span>.<span class="ident">recv</span>(), <span class="prelude-val">Some</span>(<span class="number">5</span>)); <span class="comment">// blocks until the previous send occurs</span></pre>
|
||
<p>An example of a synchronous buffered channel:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">chan</span>::<span class="ident">sync</span>(<span class="number">1</span>);
|
||
|
||
<span class="ident">send</span>.<span class="ident">send</span>(<span class="number">5</span>); <span class="comment">// doesn't block because of the buffer</span>
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">recv</span>.<span class="ident">recv</span>(), <span class="prelude-val">Some</span>(<span class="number">5</span>));
|
||
|
||
<span class="ident">drop</span>(<span class="ident">send</span>); <span class="comment">// closes the channel</span>
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">recv</span>.<span class="ident">recv</span>(), <span class="prelude-val">None</span>);</pre>
|
||
</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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "chan";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |