|
|
<!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 `Select` struct in crate `crossbeam_channel`."><meta name="keywords" content="rust, rustlang, rust-lang, Select"><title>crossbeam_channel::Select - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[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='../crossbeam_channel/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Select</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.ready">ready</a><a href="#method.ready_timeout">ready_timeout</a><a href="#method.recv">recv</a><a href="#method.select">select</a><a href="#method.select_timeout">select_timeout</a><a href="#method.send">send</a><a href="#method.try_ready">try_ready</a><a href="#method.try_select">try_select</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='index.html'>crossbeam_channel</a></p><script>window.sidebarCurrent = {name: 'Select', ty: 'struct', 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"><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><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/crossbeam_channel/select.rs.html#527-530' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>crossbeam_channel</a>::<wbr><a class="struct" href=''>Select</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Select<'a> { /* fields omitted */ }</pre></div><div class='docblock'><p>Selects from a set of channel operations.</p>
|
|
|
<p><code>Select</code> allows you to define a set of channel operations, wait until any one of them becomes
|
|
|
ready, and finally execute it. If multiple operations are ready at the same time, a random one
|
|
|
among them is selected.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready even
|
|
|
when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>The <a href="macro.select.html"><code>select!</code></a> macro is a convenience wrapper around <code>Select</code>. However, it cannot select over a
|
|
|
dynamically created list of channel operations.</p>
|
|
|
<p>Once a list of operations has been built with <code>Select</code>, there are two different ways of
|
|
|
proceeding:</p>
|
|
|
<ul>
|
|
|
<li>
|
|
|
<p>Select an operation with <a href="struct.Select.html#method.try_select"><code>try_select</code></a>, <a href="struct.Select.html#method.select"><code>select</code></a>, or <a href="struct.Select.html#method.select_timeout"><code>select_timeout</code></a>. If successful,
|
|
|
the returned selected operation has already begun and <strong>must</strong> be completed. If we don't
|
|
|
complete it, a panic will occur.</p>
|
|
|
</li>
|
|
|
<li>
|
|
|
<p>Wait for an operation to become ready with <a href="struct.Select.html#method.try_ready"><code>try_ready</code></a>, <a href="struct.Select.html#method.ready"><code>ready</code></a>, or <a href="struct.Select.html#method.ready_timeout"><code>ready_timeout</code></a>. If
|
|
|
successful, we may attempt to execute the operation, but are not obliged to. In fact, it's
|
|
|
possible for another thread to make the operation not ready just before we try executing it,
|
|
|
so it's wise to use a retry loop. However, note that these methods might return with success
|
|
|
spuriously, so it's a good idea to always double check if the operation is really ready.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<p>Use <a href="struct.Select.html#method.select"><code>select</code></a> to receive a message from a list of receivers:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">Receiver</span>, <span class="ident">RecvError</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">recv_multiple</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">rs</span>: <span class="kw-2">&</span>[<span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>]) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">RecvError</span><span class="op">></span> {
|
|
|
<span class="comment">// Build a list of operations.</span>
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">for</span> <span class="ident">r</span> <span class="kw">in</span> <span class="ident">rs</span> {
|
|
|
<span class="ident">sel</span>.<span class="ident">recv</span>(<span class="ident">r</span>);
|
|
|
}
|
|
|
|
|
|
<span class="comment">// Complete the selected operation.</span>
|
|
|
<span class="kw">let</span> <span class="ident">oper</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">select</span>();
|
|
|
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">oper</span>.<span class="ident">index</span>();
|
|
|
<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">rs</span>[<span class="ident">index</span>])
|
|
|
}</pre></div>
|
|
|
<p>Use <a href="struct.Select.html#method.ready"><code>ready</code></a> to receive a message from a list of receivers:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">Receiver</span>, <span class="ident">RecvError</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">recv_multiple</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">rs</span>: <span class="kw-2">&</span>[<span class="ident">Receiver</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>]) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">RecvError</span><span class="op">></span> {
|
|
|
<span class="comment">// Build a list of operations.</span>
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">for</span> <span class="ident">r</span> <span class="kw">in</span> <span class="ident">rs</span> {
|
|
|
<span class="ident">sel</span>.<span class="ident">recv</span>(<span class="ident">r</span>);
|
|
|
}
|
|
|
|
|
|
<span class="kw">loop</span> {
|
|
|
<span class="comment">// Wait until a receive operation becomes ready and try executing it.</span>
|
|
|
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">ready</span>();
|
|
|
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">rs</span>[<span class="ident">index</span>].<span class="ident">try_recv</span>();
|
|
|
|
|
|
<span class="comment">// If the operation turns out not to be ready, retry.</span>
|
|
|
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Err</span>(<span class="ident">e</span>) <span class="op">=</span> <span class="ident">res</span> {
|
|
|
<span class="kw">if</span> <span class="ident">e</span>.<span class="ident">is_empty</span>() {
|
|
|
<span class="kw">continue</span>;
|
|
|
}
|
|
|
}
|
|
|
|
|
|
<span class="comment">// Success!</span>
|
|
|
<span class="kw">return</span> <span class="ident">res</span>.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">RecvError</span>);
|
|
|
}
|
|
|
}</pre></div>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<'a> <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#535-916' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#548-552' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates an empty list of channel operations for selection.</p>
|
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::<span class="ident">Select</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
|
|
|
<span class="comment">// The list of operations is empty, which means no operation can be selected.</span>
|
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">sel</span>.<span class="ident">try_select</span>().<span class="ident">is_err</span>());</pre></div>
|
|
|
</div><h4 id='method.send' class="method"><code id='send.v'>pub fn <a href='#method.send' class='fnname'>send</a><T>(&mut self, s: &'a <a class="struct" href="../crossbeam_channel/struct.Sender.html" title="struct crossbeam_channel::Sender">Sender</a><T>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#569-574' title='goto source code'>[src]</a></h4><div class='docblock'><p>Adds a send operation.</p>
|
|
|
<p>Returns the index of the added operation.</p>
|
|
|
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s</span>, <span class="ident">r</span>) <span class="op">=</span> <span class="ident">unbounded</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>();
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">send</span>(<span class="kw-2">&</span><span class="ident">s</span>);</pre></div>
|
|
|
</div><h4 id='method.recv' class="method"><code id='recv.v'>pub fn <a href='#method.recv' class='fnname'>recv</a><T>(&mut self, r: &'a <a class="struct" href="../crossbeam_channel/struct.Receiver.html" title="struct crossbeam_channel::Receiver">Receiver</a><T>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#591-596' title='goto source code'>[src]</a></h4><div class='docblock'><p>Adds a receive operation.</p>
|
|
|
<p>Returns the index of the added operation.</p>
|
|
|
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s</span>, <span class="ident">r</span>) <span class="op">=</span> <span class="ident">unbounded</span>::<span class="op"><</span><span class="ident">i32</span><span class="op">></span>();
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">index</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r</span>);</pre></div>
|
|
|
</div><h4 id='method.try_select' class="method"><code id='try_select.v'>pub fn <a href='#method.try_select' class='fnname'>try_select</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../crossbeam_channel/struct.SelectedOperation.html" title="struct crossbeam_channel::SelectedOperation">SelectedOperation</a><'a>, <a class="struct" href="../crossbeam_channel/struct.TrySelectError.html" title="struct crossbeam_channel::TrySelectError">TrySelectError</a>></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#640-650' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to select one of the operations without blocking.</p>
|
|
|
<p>If an operation is ready, it is selected and returned. If multiple operations are ready at
|
|
|
the same time, a random one among them is selected. If none of the operations are ready, an
|
|
|
error is returned.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>The selected operation must be completed with <a href="struct.SelectedOperation.html#method.send"><code>SelectedOperation::send</code></a>
|
|
|
or <a href="struct.SelectedOperation.html#method.recv"><code>SelectedOperation::recv</code></a>.</p>
|
|
|
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
<span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// Both operations are initially ready, so a random one will be executed.</span>
|
|
|
<span class="kw">let</span> <span class="ident">oper</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">try_select</span>();
|
|
|
<span class="kw">match</span> <span class="ident">oper</span> {
|
|
|
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"both operations should be ready"</span>),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">oper</span>) <span class="op">=</span><span class="op">></span> <span class="kw">match</span> <span class="ident">oper</span>.<span class="ident">index</span>() {
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}
|
|
|
}</pre></div>
|
|
|
</div><h4 id='method.select' class="method"><code id='select.v'>pub fn <a href='#method.select' class='fnname'>select</a>(&mut self) -> <a class="struct" href="../crossbeam_channel/struct.SelectedOperation.html" title="struct crossbeam_channel::SelectedOperation">SelectedOperation</a><'a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#698-710' title='goto source code'>[src]</a></h4><div class='docblock'><p>Blocks until one of the operations becomes ready and selects it.</p>
|
|
|
<p>Once an operation becomes ready, it is selected and returned. If multiple operations are
|
|
|
ready at the same time, a random one among them is selected.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>The selected operation must be completed with <a href="struct.SelectedOperation.html#method.send"><code>SelectedOperation::send</code></a>
|
|
|
or <a href="struct.SelectedOperation.html#method.recv"><code>SelectedOperation::recv</code></a>.</p>
|
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|
|
<p>Panics if no operations have been added to <code>Select</code>.</p>
|
|
|
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
|
|
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">1</span>));
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
});
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> <span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>());
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// The second operation will be selected because it becomes ready first.</span>
|
|
|
<span class="kw">let</span> <span class="ident">oper</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">select</span>();
|
|
|
<span class="kw">match</span> <span class="ident">oper</span>.<span class="ident">index</span>() {
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}</pre></div>
|
|
|
</div><h4 id='method.select_timeout' class="method"><code id='select_timeout.v'>pub fn <a href='#method.select_timeout' class='fnname'>select_timeout</a>(<br> &mut self, <br> timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../crossbeam_channel/struct.SelectedOperation.html" title="struct crossbeam_channel::SelectedOperation">SelectedOperation</a><'a>, <a class="struct" href="../crossbeam_channel/struct.SelectTimeoutError.html" title="struct crossbeam_channel::SelectTimeoutError">SelectTimeoutError</a>></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#758-773' title='goto source code'>[src]</a></h4><div class='docblock'><p>Blocks for a limited time until one of the operations becomes ready and selects it.</p>
|
|
|
<p>If an operation becomes ready, it is selected and returned. If multiple operations are
|
|
|
ready at the same time, a random one among them is selected. If none of the operations
|
|
|
become ready for the specified duration, an error is returned.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>The selected operation must be completed with <a href="struct.SelectedOperation.html#method.send"><code>SelectedOperation::send</code></a>
|
|
|
or <a href="struct.SelectedOperation.html#method.recv"><code>SelectedOperation::recv</code></a>.</p>
|
|
|
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
|
|
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">1</span>));
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
});
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> <span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>());
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// The second operation will be selected because it becomes ready first.</span>
|
|
|
<span class="kw">let</span> <span class="ident">oper</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">select_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">500</span>));
|
|
|
<span class="kw">match</span> <span class="ident">oper</span> {
|
|
|
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"should not have timed out"</span>),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">oper</span>) <span class="op">=</span><span class="op">></span> <span class="kw">match</span> <span class="ident">oper</span>.<span class="ident">index</span>() {
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">oper</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}
|
|
|
}</pre></div>
|
|
|
</div><h4 id='method.try_ready' class="method"><code id='try_ready.v'>pub fn <a href='#method.try_ready' class='fnname'>try_ready</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../crossbeam_channel/struct.TryReadyError.html" title="struct crossbeam_channel::TryReadyError">TryReadyError</a>></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#811-816' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to find a ready operation without blocking.</p>
|
|
|
<p>If an operation is ready, its index is returned. If multiple operations are ready at the
|
|
|
same time, a random one among them is chosen. If none of the operations are ready, an error
|
|
|
is returned.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>Note that this method might return with success spuriously, so it's a good idea to always
|
|
|
double check if the operation is really ready.</p>
|
|
|
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
<span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// Both operations are initially ready, so a random one will be chosen.</span>
|
|
|
<span class="kw">match</span> <span class="ident">sel</span>.<span class="ident">try_ready</span>() {
|
|
|
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"both operations should be ready"</span>),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">i</span>) <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r1</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">i</span>) <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r2</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}</pre></div>
|
|
|
</div><h4 id='method.ready' class="method"><code id='ready.v'>pub fn <a href='#method.ready' class='fnname'>ready</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#860-866' title='goto source code'>[src]</a></h4><div class='docblock'><p>Blocks until one of the operations becomes ready.</p>
|
|
|
<p>Once an operation becomes ready, its index is returned. If multiple operations are ready at
|
|
|
the same time, a random one among them is chosen.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>Note that this method might return with success spuriously, so it's a good idea to always
|
|
|
double check if the operation is really ready.</p>
|
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
|
|
<p>Panics if no operations have been added to <code>Select</code>.</p>
|
|
|
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
|
|
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">1</span>));
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
});
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> <span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>());
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// The second operation will be selected because it becomes ready first.</span>
|
|
|
<span class="kw">match</span> <span class="ident">sel</span>.<span class="ident">ready</span>() {
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r1</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="ident">i</span> <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r2</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}</pre></div>
|
|
|
</div><h4 id='method.ready_timeout' class="method"><code id='ready_timeout.v'>pub fn <a href='#method.ready_timeout' class='fnname'>ready_timeout</a>(<br> &mut self, <br> timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="../crossbeam_channel/struct.ReadyTimeoutError.html" title="struct crossbeam_channel::ReadyTimeoutError">ReadyTimeoutError</a>></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#908-915' title='goto source code'>[src]</a></h4><div class='docblock'><p>Blocks for a limited time until one of the operations becomes ready.</p>
|
|
|
<p>If an operation becomes ready, its index is returned. If multiple operations are ready at
|
|
|
the same time, a random one among them is chosen. If none of the operations become ready
|
|
|
for the specified duration, an error is returned.</p>
|
|
|
<p>An operation is considered to be ready if it doesn't have to block. Note that it is ready
|
|
|
even when it will simply return an error because the channel is disconnected.</p>
|
|
|
<p>Note that this method might return with success spuriously, so it's a good idea to double
|
|
|
check if the operation is really ready.</p>
|
|
|
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">thread</span>;
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
|
|
<span class="kw">use</span> <span class="ident">crossbeam_channel</span>::{<span class="ident">unbounded</span>, <span class="ident">Select</span>};
|
|
|
|
|
|
<span class="kw">let</span> (<span class="ident">s1</span>, <span class="ident">r1</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
<span class="kw">let</span> (<span class="ident">s2</span>, <span class="ident">r2</span>) <span class="op">=</span> <span class="ident">unbounded</span>();
|
|
|
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> {
|
|
|
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_secs</span>(<span class="number">1</span>));
|
|
|
<span class="ident">s1</span>.<span class="ident">send</span>(<span class="number">10</span>).<span class="ident">unwrap</span>();
|
|
|
});
|
|
|
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">|</span><span class="op">|</span> <span class="ident">s2</span>.<span class="ident">send</span>(<span class="number">20</span>).<span class="ident">unwrap</span>());
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">sel</span> <span class="op">=</span> <span class="ident">Select</span>::<span class="ident">new</span>();
|
|
|
<span class="kw">let</span> <span class="ident">oper1</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r1</span>);
|
|
|
<span class="kw">let</span> <span class="ident">oper2</span> <span class="op">=</span> <span class="ident">sel</span>.<span class="ident">recv</span>(<span class="kw-2">&</span><span class="ident">r2</span>);
|
|
|
|
|
|
<span class="comment">// The second operation will be selected because it becomes ready first.</span>
|
|
|
<span class="kw">match</span> <span class="ident">sel</span>.<span class="ident">ready_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">500</span>)) {
|
|
|
<span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"should not have timed out"</span>),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">i</span>) <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper1</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r1</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">10</span>)),
|
|
|
<span class="prelude-val">Ok</span>(<span class="ident">i</span>) <span class="kw">if</span> <span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="ident">oper2</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">r2</span>.<span class="ident">try_recv</span>(), <span class="prelude-val">Ok</span>(<span class="number">20</span>)),
|
|
|
<span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(),
|
|
|
}</pre></div>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Send' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#532' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Default' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Default' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#926-930' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default' class="method hidden"><code id='default.v'>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#927-929' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Sync' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#533' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#918-924' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#919-923' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/crossbeam_channel/select.rs.html#932-936' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../src/crossbeam_channel/select.rs.html#933-935' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../crossbeam_channel/struct.Select.html" title="struct crossbeam_channel::Select">Select</a><'a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
</div></div></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 = "crossbeam_channel";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
