<!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 `Receiver` struct in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, Receiver"><title>std::sync::mpsc::Receiver - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../light1.35.0.css" id="themeStyle"><script src="../../../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../../../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../../../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow1.35.0.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='../../../std/index.html'><img src='../../../rust-logo1.35.0.png' alt='logo' width='100'></a><p class='location'>Struct Receiver</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.iter">iter</a><a href="#method.recv">recv</a><a href="#method.recv_deadline">recv_deadline</a><a href="#method.recv_timeout">recv_timeout</a><a href="#method.try_iter">try_iter</a><a href="#method.try_recv">try_recv</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-Send">Send</a><a href="#impl-Sync">!Sync</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">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-TryInto">TryInto</a></div></div><p class='location'><a href='../../index.html'>std</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>mpsc</a></p><script>window.sidebarCurrent = {name: 'Receiver', 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="../../../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme1.35.0.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="../../../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><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/std/sync/mpsc/mod.rs.html#325-327' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../../index.html'>std</a>::<wbr><a href='../index.html'>sync</a>::<wbr><a href='index.html'>mpsc</a>::<wbr><a class="struct" href=''>Receiver</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Receiver<T> { /* fields omitted */ }</pre></div><div class='docblock'><p>The receiving half of Rust's <a href="fn.channel.html"><code>channel</code></a> (or <a href="fn.sync_channel.html"><code>sync_channel</code></a>) type.
This half can only be owned by one thread.</p>
<p>Messages sent to the channel can be retrieved using <a href="struct.Receiver.html#method.recv"><code>recv</code></a>.</p>
<h1 id="examples" class="section-header"><a href="#examples">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">sync</span>::<span class="ident">mpsc</span>::<span class="ident">channel</span>;
<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">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">channel</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="string">"Hello world!"</span>).<span class="ident">unwrap</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">2</span>)); <span class="comment">// block for two seconds</span>
<span class="ident">send</span>.<span class="ident">send</span>(<span class="string">"Delayed for 2 seconds"</span>).<span class="ident">unwrap</span>();
});
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">recv</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>()); <span class="comment">// Received immediately</span>
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Waiting..."</span>);
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">recv</span>.<span class="ident">recv</span>().<span class="ident">unwrap</span>()); <span class="comment">// Received after 2 seconds</span><a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3Achannel%3B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3ADuration%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20channel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send(%22Hello%20world!%22).unwrap()%3B%0A%20%20%20%20thread%3A%3Asleep(Duration%3A%3Afrom_secs(2))%3B%20%2F%2F%20block%20for%20two%20seconds%0A%20%20%20%20send.send(%22Delayed%20for%202%20seconds%22).unwrap()%3B%0A%7D)%3B%0A%0Aprintln!(%22%7B%7D%22%2C%20recv.recv().unwrap())%3B%20%2F%2F%20Received%20immediately%0Aprintln!(%22Waiting...%22)%3B%0Aprintln!(%22%7B%7D%22%2C%20recv.recv().unwrap())%3B%20%2F%2F%20Received%20after%202%20seconds%0A%7D">Run</a></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<T> <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1056-1513' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_recv' class="method"><code id='try_recv.v'>pub fn <a href='#method.try_recv' class='fnname'>try_recv</a>(&self) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <a class="enum" href="../../../std/sync/mpsc/enum.TryRecvError.html" title="enum std::sync::mpsc::TryRecvError">TryRecvError</a>></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1085-1132' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to return a pending value on this receiver without blocking.</p>
<p>This method will never block the caller in order to wait for data to
become available. Instead, this will always return immediately with a
possible option of pending data on the channel.</p>
<p>This is useful for a flavor of "optimistic check" before deciding to
block on a receiver.</p>
<p>Compared with <a href="struct.Receiver.html#method.recv"><code>recv</code></a>, this function has two failure cases instead of one
(one for disconnection, one for an empty buffer).</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">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>::{<span class="ident">Receiver</span>, <span class="ident">channel</span>};
<span class="kw">let</span> (<span class="kw">_</span>, <span class="ident">receiver</span>): (<span class="kw">_</span>, <span class="ident">Receiver</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span>) <span class="op">=</span> <span class="ident">channel</span>();
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">receiver</span>.<span class="ident">try_recv</span>().<span class="ident">is_err</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3A%7BReceiver%2C%20channel%7D%3B%0A%0Alet%20(_%2C%20receiver)%3A%20(_%2C%20Receiver%3Ci32%3E)%20%3D%20channel()%3B%0A%0Aassert!(receiver.try_recv().is_err())%3B%0A%7D">Run</a></pre></div>
</div><h4 id='method.recv' class="method"><code id='recv.v'>pub fn <a href='#method.recv' class='fnname'>recv</a>(&self) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <a class="struct" href="../../../std/sync/mpsc/struct.RecvError.html" title="struct std::sync::mpsc::RecvError">RecvError</a>></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1192-1224' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to wait for a value on this receiver, returning an error if the
corresponding channel has hung up.</p>
<p>This function will always block the current thread if there is no data
available and it's possible for more data to be sent. Once a message is
sent to the corresponding <a href="struct.Sender.html"><code>Sender</code></a> (or <a href="struct.SyncSender.html"><code>SyncSender</code></a>), then this
receiver will wake up and return that message.</p>
<p>If the corresponding <a href="struct.Sender.html"><code>Sender</code></a> has disconnected, or it disconnects while
this call is blocking, this call will wake up and return <a href="../../../std/result/enum.Result.html#variant.Err"><code>Err</code></a> to
indicate that no more messages can ever be received on this channel.
However, since channels are buffered, messages sent before the disconnect
will still be properly received.</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">sync</span>::<span class="ident">mpsc</span>;
<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">mpsc</span>::<span class="ident">channel</span>();
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</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">1u8</span>).<span class="ident">unwrap</span>();
});
<span class="ident">handle</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="number">1</span>), <span class="ident">recv</span>.<span class="ident">recv</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0Ause%20std%3A%3Athread%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0Alet%20handle%20%3D%20thread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send(1u8).unwrap()%3B%0A%7D)%3B%0A%0Ahandle.join().unwrap()%3B%0A%0Aassert_eq!(Ok(1)%2C%20recv.recv())%3B%0A%7D">Run</a></pre></div>
<p>Buffering behavior:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
<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">sync</span>::<span class="ident">mpsc</span>::<span class="ident">RecvError</span>;
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</span>();
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</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">1u8</span>).<span class="ident">unwrap</span>();
<span class="ident">send</span>.<span class="ident">send</span>(<span class="number">2</span>).<span class="ident">unwrap</span>();
<span class="ident">send</span>.<span class="ident">send</span>(<span class="number">3</span>).<span class="ident">unwrap</span>();
<span class="ident">drop</span>(<span class="ident">send</span>);
});
<span class="comment">// wait for the thread to join so we ensure the sender is dropped</span>
<span class="ident">handle</span>.<span class="ident">join</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="number">1</span>), <span class="ident">recv</span>.<span class="ident">recv</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="number">2</span>), <span class="ident">recv</span>.<span class="ident">recv</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Ok</span>(<span class="number">3</span>), <span class="ident">recv</span>.<span class="ident">recv</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Err</span>(<span class="ident">RecvError</span>), <span class="ident">recv</span>.<span class="ident">recv</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3ARecvError%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0Alet%20handle%20%3D%20thread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send(1u8).unwrap()%3B%0A%20%20%20%20send.send(2).unwrap()%3B%0A%20%20%20%20send.send(3).unwrap()%3B%0A%20%20%20%20drop(send)%3B%0A%7D)%3B%0A%0A%2F%2F%20wait%20for%20the%20thread%20to%20join%20so%20we%20ensure%20the%20sender%20is%20dropped%0Ahandle.join().unwrap()%3B%0A%0Aassert_eq!(Ok(1)%2C%20recv.recv())%3B%0Aassert_eq!(Ok(2)%2C%20recv.recv())%3B%0Aassert_eq!(Ok(3)%2C%20recv.recv())%3B%0Aassert_eq!(Err(RecvError)%2C%20recv.recv())%3B%0A%7D">Run</a></pre></div>
</div><h4 id='method.recv_timeout' class="method"><code id='recv_timeout.v'>pub fn <a href='#method.recv_timeout' class='fnname'>recv_timeout</a>(&self, timeout: <a class="struct" href="../../../std/time/struct.Duration.html" title="struct std::time::Duration">Duration</a>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <a class="enum" href="../../../std/sync/mpsc/enum.RecvTimeoutError.html" title="enum std::sync::mpsc::RecvTimeoutError">RecvTimeoutError</a>></code><div class='since' title='Stable since Rust version 1.12.0'>1.12.0</div><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1313-1325' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to wait for a value on this receiver, returning an error if the
corresponding channel has hung up, or if it waits more than <code>timeout</code>.</p>
<p>This function will always block the current thread if there is no data
available and it's possible for more data to be sent. Once a message is
sent to the corresponding <a href="struct.Sender.html"><code>Sender</code></a> (or <a href="struct.SyncSender.html"><code>SyncSender</code></a>), then this
receiver will wake up and return that message.</p>
<p>If the corresponding <a href="struct.Sender.html"><code>Sender</code></a> has disconnected, or it disconnects while
this call is blocking, this call will wake up and return <a href="../../../std/result/enum.Result.html#variant.Err"><code>Err</code></a> to
indicate that no more messages can ever be received on this channel.
However, since channels are buffered, messages sent before the disconnect
will still be properly received.</p>
<h1 id="known-issues" class="section-header"><a href="#known-issues">Known Issues</a></h1>
<p>There is currently a known issue (see <a href="https://github.com/rust-lang/rust/issues/39364"><code>#39364</code></a>) that causes <code>recv_timeout</code>
to panic unexpectedly with the following example:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>::<span class="ident">channel</span>;
<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">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>::<span class="op"><</span><span class="ident">String</span><span class="op">></span>();
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">10</span>);
<span class="kw">loop</span> {
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"recv"</span>);
<span class="kw">let</span> <span class="ident">_r</span> <span class="op">=</span> <span class="ident">rx</span>.<span class="ident">recv_timeout</span>(<span class="ident">d</span>);
}
});
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">100</span>));
<span class="kw">let</span> <span class="ident">_c1</span> <span class="op">=</span> <span class="ident">tx</span>.<span class="ident">clone</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>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3Achannel%3B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3ADuration%3B%0A%0Alet%20(tx%2C%20rx)%20%3D%20channel%3A%3A%3CString%3E()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20let%20d%20%3D%20Duration%3A%3Afrom_millis(10)%3B%0A%20%20%20%20loop%20%7B%0A%20%20%20%20%20%20%20%20println!(%22recv%22)%3B%0A%20%20%20%20%20%20%20%20let%20_r%20%3D%20rx.recv_timeout(d)%3B%0A%20%20%20%20%7D%0A%7D)%3B%0A%0Athread%3A%3Asleep(Duration%3A%3Afrom_millis(100))%3B%0Alet%20_c1%20%3D%20tx.clone()%3B%0A%0Athread%3A%3Asleep(Duration%3A%3Afrom_secs(1))%3B%0A%7D">Run</a></pre></div>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<p>Successfully receiving value before encountering timeout:</p>
<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">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</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="string">'a'</span>).<span class="ident">unwrap</span>();
});
<span class="macro">assert_eq</span><span class="macro">!</span>(
<span class="ident">recv</span>.<span class="ident">recv_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">400</span>)),
<span class="prelude-val">Ok</span>(<span class="string">'a'</span>)
);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3ADuration%3B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send('a').unwrap()%3B%0A%7D)%3B%0A%0Aassert_eq!(%0A%20%20%20%20recv.recv_timeout(Duration%3A%3Afrom_millis(400))%2C%0A%20%20%20%20Ok('a')%0A)%3B%0A%7D">Run</a></pre></div>
<p>Receiving an error upon reaching timeout:</p>
<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">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</span>();
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">800</span>));
<span class="ident">send</span>.<span class="ident">send</span>(<span class="string">'a'</span>).<span class="ident">unwrap</span>();
});
<span class="macro">assert_eq</span><span class="macro">!</span>(
<span class="ident">recv</span>.<span class="ident">recv_timeout</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">400</span>)),
<span class="prelude-val">Err</span>(<span class="ident">mpsc</span>::<span class="ident">RecvTimeoutError</span>::<span class="ident">Timeout</span>)
);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3ADuration%3B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20thread%3A%3Asleep(Duration%3A%3Afrom_millis(800))%3B%0A%20%20%20%20send.send('a').unwrap()%3B%0A%7D)%3B%0A%0Aassert_eq!(%0A%20%20%20%20recv.recv_timeout(Duration%3A%3Afrom_millis(400))%2C%0A%20%20%20%20Err(mpsc%3A%3ARecvTimeoutError%3A%3ATimeout)%0A)%3B%0A%7D">Run</a></pre></div>
</div><h4 id='method.recv_deadline' class="method"><code id='recv_deadline.v'>pub fn <a href='#method.recv_deadline' class='fnname'>recv_deadline</a>(&self, deadline: <a class="struct" href="../../../std/time/struct.Instant.html" title="struct std::time::Instant">Instant</a>) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <a class="enum" href="../../../std/sync/mpsc/enum.RecvTimeoutError.html" title="enum std::sync::mpsc::RecvTimeoutError">RecvTimeoutError</a>></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1388-1437' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>deadline_api</code> <a href="https://github.com/rust-lang/rust/issues/46316">#46316</a>)</div></div><div class='docblock'><p>Attempts to wait for a value on this receiver, returning an error if the
corresponding channel has hung up, or if <code>deadline</code> is reached.</p>
<p>This function will always block the current thread if there is no data
available and it's possible for more data to be sent. Once a message is
sent to the corresponding <a href="struct.Sender.html"><code>Sender</code></a> (or <a href="struct.SyncSender.html"><code>SyncSender</code></a>), then this
receiver will wake up and return that message.</p>
<p>If the corresponding <a href="struct.Sender.html"><code>Sender</code></a> has disconnected, or it disconnects while
this call is blocking, this call will wake up and return <a href="../../../std/result/enum.Result.html#variant.Err"><code>Err</code></a> to
indicate that no more messages can ever be received on this channel.
However, since channels are buffered, messages sent before the disconnect
will still be properly received.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<p>Successfully receiving value before reaching deadline:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">deadline_api</span>)]</span>
<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="ident">Instant</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</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="string">'a'</span>).<span class="ident">unwrap</span>();
});
<span class="macro">assert_eq</span><span class="macro">!</span>(
<span class="ident">recv</span>.<span class="ident">recv_deadline</span>(<span class="ident">Instant</span>::<span class="ident">now</span>() <span class="op">+</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">400</span>)),
<span class="prelude-val">Ok</span>(<span class="string">'a'</span>)
);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(deadline_api)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3A%7BDuration%2C%20Instant%7D%3B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send('a').unwrap()%3B%0A%7D)%3B%0A%0Aassert_eq!(%0A%20%20%20%20recv.recv_deadline(Instant%3A%3Anow()%20%2B%20Duration%3A%3Afrom_millis(400))%2C%0A%20%20%20%20Ok('a')%0A)%3B%0A%7D&version=nightly">Run</a></pre></div>
<p>Receiving an error upon reaching deadline:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="attribute">#![<span class="ident">feature</span>(<span class="ident">deadline_api</span>)]</span>
<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="ident">Instant</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>;
<span class="kw">let</span> (<span class="ident">send</span>, <span class="ident">recv</span>) <span class="op">=</span> <span class="ident">mpsc</span>::<span class="ident">channel</span>();
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</span> <span class="op">||</span> {
<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">800</span>));
<span class="ident">send</span>.<span class="ident">send</span>(<span class="string">'a'</span>).<span class="ident">unwrap</span>();
});
<span class="macro">assert_eq</span><span class="macro">!</span>(
<span class="ident">recv</span>.<span class="ident">recv_deadline</span>(<span class="ident">Instant</span>::<span class="ident">now</span>() <span class="op">+</span> <span class="ident">Duration</span>::<span class="ident">from_millis</span>(<span class="number">400</span>)),
<span class="prelude-val">Err</span>(<span class="ident">mpsc</span>::<span class="ident">RecvTimeoutError</span>::<span class="ident">Timeout</span>)
);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(deadline_api)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3A%7BDuration%2C%20Instant%7D%3B%0Ause%20std%3A%3Async%3A%3Ampsc%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20mpsc%3A%3Achannel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20thread%3A%3Asleep(Duration%3A%3Afrom_millis(800))%3B%0A%20%20%20%20send.send('a').unwrap()%3B%0A%7D)%3B%0A%0Aassert_eq!(%0A%20%20%20%20recv.recv_deadline(Instant%3A%3Anow()%20%2B%20Duration%3A%3Afrom_millis(400))%2C%0A%20%20%20%20Err(mpsc%3A%3ARecvTimeoutError%3A%3ATimeout)%0A)%3B%0A%7D&version=nightly">Run</a></pre></div>
</div><h4 id='method.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = T;</span></code></div></div><code id='iter.v'>pub fn <a href='#method.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><T></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1466-1468' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns an iterator that will block waiting for messages, but never
<a href="../../../std/macro.panic.html"><code>panic!</code></a>. It will return <a href="../../../std/option/enum.Option.html#variant.None"><code>None</code></a> when the channel has hung up.</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">sync</span>::<span class="ident">mpsc</span>::<span class="ident">channel</span>;
<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">channel</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">1</span>).<span class="ident">unwrap</span>();
<span class="ident">send</span>.<span class="ident">send</span>(<span class="number">2</span>).<span class="ident">unwrap</span>();
<span class="ident">send</span>.<span class="ident">send</span>(<span class="number">3</span>).<span class="ident">unwrap</span>();
});
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iter</span> <span class="op">=</span> <span class="ident">recv</span>.<span class="ident">iter</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3Achannel%3B%0Ause%20std%3A%3Athread%3B%0A%0Alet%20(send%2C%20recv)%20%3D%20channel()%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20send.send(1).unwrap()%3B%0A%20%20%20%20send.send(2).unwrap()%3B%0A%20%20%20%20send.send(3).unwrap()%3B%0A%7D)%3B%0A%0Alet%20mut%20iter%20%3D%20recv.iter()%3B%0Aassert_eq!(iter.next()%2C%20Some(1))%3B%0Aassert_eq!(iter.next()%2C%20Some(2))%3B%0Aassert_eq!(iter.next()%2C%20Some(3))%3B%0Aassert_eq!(iter.next()%2C%20None)%3B%0A%7D">Run</a></pre></div>
</div><h4 id='method.try_iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.TryIter.html" title="struct std::sync::mpsc::TryIter">TryIter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.TryIter.html" title="struct std::sync::mpsc::TryIter">TryIter</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="struct" href="../../../std/sync/mpsc/struct.TryIter.html" title="struct std::sync::mpsc::TryIter">TryIter</a><'a, T></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = T;</span></code></div></div><code id='try_iter.v'>pub fn <a href='#method.try_iter' class='fnname'>try_iter</a>(&self) -> <a class="struct" href="../../../std/sync/mpsc/struct.TryIter.html" title="struct std::sync::mpsc::TryIter">TryIter</a><T></code><div class='since' title='Stable since Rust version 1.15.0'>1.15.0</div><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1509-1511' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns an iterator that will attempt to yield all pending values.
It will return <code>None</code> if there are no more pending values or if the
channel has hung up. The iterator will never <a href="../../../std/macro.panic.html"><code>panic!</code></a> or block the
user by waiting for values.</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">sync</span>::<span class="ident">mpsc</span>::<span class="ident">channel</span>;
<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">let</span> (<span class="ident">sender</span>, <span class="ident">receiver</span>) <span class="op">=</span> <span class="ident">channel</span>();
<span class="comment">// nothing is in the buffer yet</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">receiver</span>.<span class="ident">try_iter</span>().<span class="ident">next</span>().<span class="ident">is_none</span>());
<span class="ident">thread</span>::<span class="ident">spawn</span>(<span class="kw">move</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">sender</span>.<span class="ident">send</span>(<span class="number">1</span>).<span class="ident">unwrap</span>();
<span class="ident">sender</span>.<span class="ident">send</span>(<span class="number">2</span>).<span class="ident">unwrap</span>();
<span class="ident">sender</span>.<span class="ident">send</span>(<span class="number">3</span>).<span class="ident">unwrap</span>();
});
<span class="comment">// nothing is in the buffer yet</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">receiver</span>.<span class="ident">try_iter</span>().<span class="ident">next</span>().<span class="ident">is_none</span>());
<span class="comment">// block for two seconds</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">2</span>));
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iter</span> <span class="op">=</span> <span class="ident">receiver</span>.<span class="ident">try_iter</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="number">3</span>));
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iter</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Async%3A%3Ampsc%3A%3Achannel%3B%0Ause%20std%3A%3Athread%3B%0Ause%20std%3A%3Atime%3A%3ADuration%3B%0A%0Alet%20(sender%2C%20receiver)%20%3D%20channel()%3B%0A%0A%2F%2F%20nothing%20is%20in%20the%20buffer%20yet%0Aassert!(receiver.try_iter().next().is_none())%3B%0A%0Athread%3A%3Aspawn(move%20%7C%7C%20%7B%0A%20%20%20%20thread%3A%3Asleep(Duration%3A%3Afrom_secs(1))%3B%0A%20%20%20%20sender.send(1).unwrap()%3B%0A%20%20%20%20sender.send(2).unwrap()%3B%0A%20%20%20%20sender.send(3).unwrap()%3B%0A%7D)%3B%0A%0A%2F%2F%20nothing%20is%20in%20the%20buffer%20yet%0Aassert!(receiver.try_iter().next().is_none())%3B%0A%0A%2F%2F%20block%20for%20two%20seconds%0Athread%3A%3Asleep(Duration%3A%3Afrom_secs(2))%3B%0A%0Alet%20mut%20iter%20%3D%20receiver.try_iter()%3B%0Aassert_eq!(iter.next()%2C%20Some(1))%3B%0Aassert_eq!(iter.next()%2C%20Some(2))%3B%0Aassert_eq!(iter.next()%2C%20Some(3))%3B%0Aassert_eq!(iter.next()%2C%20None)%3B%0A%7D">Run</a></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-Debug' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/fmt/trait.Debug.html" title="trait std::fmt::Debug">Debug</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-Debug' class='anchor'></a><div class='since' title='Stable since Rust version 1.8.0'>1.8.0</div><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1638-1642' 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='../../../std/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="../../../std/fmt/struct.Formatter.html" title="struct std::fmt::Formatter">Formatter</a>) -> <a class="type" href="../../../std/fmt/type.Result.html" title="type std::fmt::Result">Result</a></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1639-1641' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="../../../std/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl<T: <a class="trait" href="../../../std/marker/trait.Send.html" title="trait std::marker::Send">Send</a>> <a class="trait" href="../../../std/marker/trait.Send.html" title="trait std::marker::Send">Send</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-Send' class='anchor'></a><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#332' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<T> !<a class="trait" href="../../../std/marker/trait.Sync.html" title="trait std::marker::Sync">Sync</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-Sync' class='anchor'></a><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#335' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Drop' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/ops/trait.Drop.html" title="trait std::ops::Drop">Drop</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1626-1635' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='../../../std/ops/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1627-1634' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="../../../std/ops/trait.Drop.html#tymethod.drop">Read more</a></p>
</div></div><h3 id='impl-IntoIterator' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="../../../std/iter/trait.IntoIterator.html" title="trait std::iter::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-IntoIterator' class='anchor'></a><div class='since' title='Stable since Rust version 1.1.0'>1.1.0</div><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1602-1607' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><code id='Item.t'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = T</code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
</div><h4 id='associatedtype.IntoIter' class="type"><code id='IntoIter.t'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
</div><h4 id='method.into_iter' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = T;</span></code></div></div><code id='into_iter.v'>fn <a href='../../../std/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> <a class="struct" href="../../../std/sync/mpsc/struct.Iter.html" title="struct std::sync::mpsc::Iter">Iter</a><'a, T></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1606' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="../../../std/iter/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
</div></div><h3 id='impl-IntoIterator-1' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/iter/trait.IntoIterator.html" title="trait std::iter::IntoIterator">IntoIterator</a> for <a class="struct" href="../../../std/sync/mpsc/struct.Receiver.html" title="struct std::sync::mpsc::Receiver">Receiver</a><T></code><a href='#impl-IntoIterator-1' class='anchor'></a><div class='since' title='Stable since Rust version 1.1.0'>1.1.0</div><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1616-1623' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><code id='Item.t-1'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = T</code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
</div><h4 id='associatedtype.IntoIter-1' class="type"><code id='IntoIter.t-1'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../../../std/sync/mpsc/struct.IntoIter.html" title="struct std::sync::mpsc::IntoIter">IntoIter</a><T></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
</div><h4 id='method.into_iter-1' class="method hidden"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.IntoIter.html" title="struct std::sync::mpsc::IntoIter">IntoIter</a><T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../../std/sync/mpsc/struct.IntoIter.html" title="struct std::sync::mpsc::IntoIter">IntoIter</a><T></h3><code class="content"><span class="where fmt-newline">impl<T> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="struct" href="../../../std/sync/mpsc/struct.IntoIter.html" title="struct std::sync::mpsc::IntoIter">IntoIter</a><T></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = T;</span></code></div></div><code id='into_iter.v-1'>fn <a href='../../../std/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> <a class="struct" href="../../../std/sync/mpsc/struct.IntoIter.html" title="struct std::sync::mpsc::IntoIter">IntoIter</a><T></code><a class='srclink' href='../../../src/std/sync/mpsc/mod.rs.html#1620-1622' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="../../../std/iter/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
</div></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-TryFrom' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.Into.html" title="trait std::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#565-571' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='../../../std/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../../std/convert/enum.Infallible.html" title="enum std::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='../../../std/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><T, <T as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='../../../src/core/convert.rs.html#568-570' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/convert/trait.From.html" title="trait std::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#546-548' 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='../../../std/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='../../../src/core/convert.rs.html#547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-IntoIterator-2' class='impl'><code class='in-band'>impl<I> <a class="trait" href="../../../std/iter/trait.IntoIterator.html" title="trait std::iter::IntoIterator">IntoIterator</a> for I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>, </span></code><a href='#impl-IntoIterator-2' class='anchor'></a><a class='srclink' href='../../../src/core/iter/traits/collect.rs.html#241-248' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><code id='Item.t-2'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
</div><h4 id='associatedtype.IntoIter-2' class="type"><code id='IntoIter.t-2'>type <a href='../../../std/iter/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = I</code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
</div><h4 id='method.into_iter-2' class="method hidden"><code id='into_iter.v-2'>fn <a href='../../../std/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> I</code><a class='srclink' href='../../../src/core/iter/traits/collect.rs.html#245-247' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="../../../std/iter/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
</div></div><h3 id='impl-TryInto' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.TryInto.html" title="trait std::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#553-560' 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='../../../std/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::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='../../../std/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="../../../std/result/enum.Result.html" title="enum std::result::Result">Result</a><U, <U as <a class="trait" href="../../../std/convert/trait.TryFrom.html" title="trait std::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="../../../std/convert/trait.TryFrom.html#associatedtype.Error" title="type std::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='../../../src/core/convert.rs.html#557-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Into' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="../../../std/convert/trait.Into.html" title="trait std::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="../../../std/convert/trait.From.html" title="trait std::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a><a class='srclink' href='../../../src/core/convert.rs.html#537-542' 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='../../../std/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='../../../src/core/convert.rs.html#539-541' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Borrow' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/borrow/trait.Borrow.html" title="trait std::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a><a class='srclink' href='../../../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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/marker/trait.Unpin.html" title="trait std::marker::Unpin">Unpin</a> + <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/future/trait.Future.html#associatedtype.Output' class="type">Output</a> = <F as <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a>>::<a class="type" href="../../../std/future/trait.Future.html#associatedtype.Output" title="type std::future::Future::Output">Output</a>;</span><span class="where fmt-newline">impl<'_, I> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a>;</span><span class="where fmt-newline">impl<R: <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>R</span><span class="where fmt-newline">impl<W: <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>W</span></code></div></div><code id='borrow.v'>fn <a href='../../../std/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="../../primitive.reference.html">&</a>T</code><a class='srclink' href='../../../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="../../../std/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-BorrowMut' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/borrow/trait.BorrowMut.html" title="trait std::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a><a class='srclink' href='../../../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"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F</h3><code class="content"><span class="where fmt-newline">impl<'_, F> <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../std/marker/trait.Unpin.html" title="trait std::marker::Unpin">Unpin</a> + <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/future/trait.Future.html#associatedtype.Output' class="type">Output</a> = <F as <a class="trait" href="../../../std/future/trait.Future.html" title="trait std::future::Future">Future</a>>::<a class="type" href="../../../std/future/trait.Future.html#associatedtype.Output" title="type std::future::Future::Output">Output</a>;</span><span class="where fmt-newline">impl<'_, I> <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a>;</span><span class="where fmt-newline">impl<R: <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>R</span><span class="where fmt-newline">impl<W: <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, '_> <a class="trait" href="../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../primitive.reference.html">&'_ mut </a>W</span></code></div></div><code id='borrow_mut.v'>fn <a href='../../../std/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="../../primitive.reference.html">&mut </a>T</code><a class='srclink' href='../../../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="../../../std/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../std/any/trait.Any.html" title="trait std::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='../../../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='../../../std/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="../../../std/any/struct.TypeId.html" title="struct std::any::TypeId">TypeId</a></code><a class='srclink' href='../../../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="../../../std/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 = "std";</script><script src="../../../aliases.js"></script><script src="../../../main1.35.0.js"></script><script defer src="../../../search-index.js"></script></body></html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
0c2243f8a1696816431e7210e991fa52
>
files
>
16878
