357 lines
57 KiB
HTML
357 lines
57 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Receives values from the associated `Sender`."><title>Receiver in tokio::sync::mpsc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Receiver</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../tokio/index.html">tokio</a><span class="version">1.49.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Receiver</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.blocking_recv" title="blocking_recv">blocking_recv</a></li><li><a href="#method.blocking_recv_many" title="blocking_recv_many">blocking_recv_many</a></li><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.close" title="close">close</a></li><li><a href="#method.is_closed" title="is_closed">is_closed</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.max_capacity" title="max_capacity">max_capacity</a></li><li><a href="#method.poll_recv" title="poll_recv">poll_recv</a></li><li><a href="#method.poll_recv_many" title="poll_recv_many">poll_recv_many</a></li><li><a href="#method.recv" title="recv">recv</a></li><li><a href="#method.recv_many" title="recv_many">recv_many</a></li><li><a href="#method.sender_strong_count" title="sender_strong_count">sender_strong_count</a></li><li><a href="#method.sender_weak_count" title="sender_weak_count">sender_weak_count</a></li><li><a href="#method.try_recv" title="try_recv">try_recv</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Receiver%3CT%3E" title="Debug">Debug</a></li><li><a href="#impl-Unpin-for-Receiver%3CT%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Receiver%3CT%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Receiver%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Receiver%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-UnwindSafe-for-Receiver%3CT%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>sync::<wbr>mpsc</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">tokio</a>::<wbr><a href="../index.html">sync</a>::<wbr><a href="index.html">mpsc</a></div><h1>Struct <span class="struct">Receiver</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/tokio/sync/mpsc/bounded.rs.html#106-109">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Receiver<T> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Receives values from the associated <code>Sender</code>.</p>
|
||
<p>Instances are created by the <a href="fn.channel.html" title="fn tokio::sync::mpsc::channel"><code>channel</code></a> function.</p>
|
||
<p>This receiver can be turned into a <code>Stream</code> using <a href="https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.ReceiverStream.html"><code>ReceiverStream</code></a>.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#181-740">Source</a><a href="#impl-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.recv" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#243-246">Source</a><h4 class="code-header">pub async fn <a href="#method.recv" class="fn">recv</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Receives the next value for this receiver.</p>
|
||
<p>This method returns <code>None</code> if the channel has been closed and there are
|
||
no remaining messages in the channel’s buffer. This indicates that no
|
||
further values can ever be received from this <code>Receiver</code>. The channel is
|
||
closed when all senders have been dropped, or when <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is called.</p>
|
||
<p>If there are no messages in the channel’s buffer, but the channel has
|
||
not yet been closed, this method will sleep until a message is sent or
|
||
the channel is closed. Note that if <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is called, but there are
|
||
still outstanding <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit"><code>Permits</code></a> from before it was closed, the channel is
|
||
not considered closed by <code>recv</code> until the permits are released.</p>
|
||
<h5 id="cancel-safety"><a class="doc-anchor" href="#cancel-safety">§</a>Cancel safety</h5>
|
||
<p>This method is cancel safe. If <code>recv</code> is used as the event in a
|
||
<a href="../../macro.select.html" title="macro tokio::select"><code>tokio::select!</code></a> statement and some other branch
|
||
completes first, it is guaranteed that no messages were received on this
|
||
channel.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">100</span>);
|
||
|
||
tokio::spawn(<span class="kw">async move </span>{
|
||
tx.send(<span class="string">"hello"</span>).<span class="kw">await</span>.unwrap();
|
||
});
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"hello"</span>), rx.recv().<span class="kw">await</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, rx.recv().<span class="kw">await</span>);</code></pre></div>
|
||
<p>Values are buffered:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">100</span>);
|
||
|
||
tx.send(<span class="string">"hello"</span>).<span class="kw">await</span>.unwrap();
|
||
tx.send(<span class="string">"world"</span>).<span class="kw">await</span>.unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"hello"</span>), rx.recv().<span class="kw">await</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="string">"world"</span>), rx.recv().<span class="kw">await</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.recv_many" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#319-322">Source</a><h4 class="code-header">pub async fn <a href="#method.recv_many" class="fn">recv_many</a>(&mut self, buffer: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>, limit: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Receives the next values for this receiver and extends <code>buffer</code>.</p>
|
||
<p>This method extends <code>buffer</code> by no more than a fixed number of values
|
||
as specified by <code>limit</code>. If <code>limit</code> is zero, the function immediately
|
||
returns <code>0</code>. The return value is the number of values added to <code>buffer</code>.</p>
|
||
<p>For <code>limit > 0</code>, if there are no messages in the channel’s queue, but
|
||
the channel has not yet been closed, this method will sleep until a
|
||
message is sent or the channel is closed. Note that if <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is
|
||
called, but there are still outstanding <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit"><code>Permits</code></a> from before it was
|
||
closed, the channel is not considered closed by <code>recv_many</code> until the
|
||
permits are released.</p>
|
||
<p>For non-zero values of <code>limit</code>, this method will never return <code>0</code> unless
|
||
the channel has been closed and there are no remaining messages in the
|
||
channel’s queue. This indicates that no further values can ever be
|
||
received from this <code>Receiver</code>. The channel is closed when all senders
|
||
have been dropped, or when <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is called.</p>
|
||
<p>The capacity of <code>buffer</code> is increased as needed.</p>
|
||
<h5 id="cancel-safety-1"><a class="doc-anchor" href="#cancel-safety-1">§</a>Cancel safety</h5>
|
||
<p>This method is cancel safe. If <code>recv_many</code> is used as the event in a
|
||
<a href="../../macro.select.html" title="macro tokio::select"><code>tokio::select!</code></a> statement and some other branch
|
||
completes first, it is guaranteed that no messages were received on this
|
||
channel.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>buffer: Vec<<span class="kw-2">&</span>str> = Vec::with_capacity(<span class="number">2</span>);
|
||
<span class="kw">let </span>limit = <span class="number">2</span>;
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">100</span>);
|
||
<span class="kw">let </span>tx2 = tx.clone();
|
||
tx2.send(<span class="string">"first"</span>).<span class="kw">await</span>.unwrap();
|
||
tx2.send(<span class="string">"second"</span>).<span class="kw">await</span>.unwrap();
|
||
tx2.send(<span class="string">"third"</span>).<span class="kw">await</span>.unwrap();
|
||
|
||
<span class="comment">// Call `recv_many` to receive up to `limit` (2) values.
|
||
</span><span class="macro">assert_eq!</span>(<span class="number">2</span>, rx.recv_many(<span class="kw-2">&mut </span>buffer, limit).<span class="kw">await</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="string">"first"</span>, <span class="string">"second"</span>], buffer);
|
||
|
||
<span class="comment">// If the buffer is full, the next call to `recv_many`
|
||
// reserves additional capacity.
|
||
</span><span class="macro">assert_eq!</span>(<span class="number">1</span>, rx.recv_many(<span class="kw-2">&mut </span>buffer, <span class="number">1</span>).<span class="kw">await</span>);
|
||
|
||
tokio::spawn(<span class="kw">async move </span>{
|
||
tx.send(<span class="string">"fourth"</span>).<span class="kw">await</span>.unwrap();
|
||
});
|
||
|
||
<span class="comment">// 'tx' is dropped, but `recv_many`
|
||
// is guaranteed not to return 0 as the channel
|
||
// is not yet closed.
|
||
</span><span class="macro">assert_eq!</span>(<span class="number">1</span>, rx.recv_many(<span class="kw-2">&mut </span>buffer, <span class="number">1</span>).<span class="kw">await</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="string">"first"</span>, <span class="string">"second"</span>, <span class="string">"third"</span>, <span class="string">"fourth"</span>], buffer);
|
||
|
||
<span class="comment">// Once the last sender is dropped, the channel is
|
||
// closed and `recv_many` returns 0, capacity unchanged.
|
||
</span>drop(tx2);
|
||
<span class="macro">assert_eq!</span>(<span class="number">0</span>, rx.recv_many(<span class="kw-2">&mut </span>buffer, limit).<span class="kw">await</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="string">"first"</span>, <span class="string">"second"</span>, <span class="string">"third"</span>, <span class="string">"fourth"</span>], buffer);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.try_recv" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#364-366">Source</a><h4 class="code-header">pub fn <a href="#method.try_recv" class="fn">try_recv</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="error/enum.TryRecvError.html" title="enum tokio::sync::mpsc::error::TryRecvError">TryRecvError</a>></h4></section></summary><div class="docblock"><p>Tries to receive the next value for this receiver.</p>
|
||
<p>This method returns the <a href="error/enum.TryRecvError.html#variant.Empty" title="variant tokio::sync::mpsc::error::TryRecvError::Empty"><code>Empty</code></a> error if the channel is currently
|
||
empty, but there are still outstanding <a href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">senders</a> or <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit">permits</a>.</p>
|
||
<p>This method returns the <a href="error/enum.TryRecvError.html#variant.Disconnected" title="variant tokio::sync::mpsc::error::TryRecvError::Disconnected"><code>Disconnected</code></a> error if the channel is
|
||
currently empty, and there are no outstanding <a href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">senders</a> or <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit">permits</a>.</p>
|
||
<p>Unlike the <a href="struct.Receiver.html#method.poll_recv" title="method tokio::sync::mpsc::Receiver::poll_recv"><code>poll_recv</code></a> method, this method will never return an
|
||
<a href="error/enum.TryRecvError.html#variant.Empty" title="variant tokio::sync::mpsc::error::TryRecvError::Empty"><code>Empty</code></a> error spuriously.</p>
|
||
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
<span class="kw">use </span>tokio::sync::mpsc::error::TryRecvError;
|
||
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">100</span>);
|
||
|
||
tx.send(<span class="string">"hello"</span>).<span class="kw">await</span>.unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Ok</span>(<span class="string">"hello"</span>), rx.try_recv());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Err</span>(TryRecvError::Empty), rx.try_recv());
|
||
|
||
tx.send(<span class="string">"hello"</span>).<span class="kw">await</span>.unwrap();
|
||
<span class="comment">// Drop the last sender, closing the channel.
|
||
</span>drop(tx);
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Ok</span>(<span class="string">"hello"</span>), rx.try_recv());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Err</span>(TryRecvError::Disconnected), rx.try_recv());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.blocking_recv" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#424-426">Source</a><h4 class="code-header">pub fn <a href="#method.blocking_recv" class="fn">blocking_recv</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Blocking receive to call outside of asynchronous contexts.</p>
|
||
<p>This method returns <code>None</code> if the channel has been closed and there are
|
||
no remaining messages in the channel’s buffer. This indicates that no
|
||
further values can ever be received from this <code>Receiver</code>. The channel is
|
||
closed when all senders have been dropped, or when <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is called.</p>
|
||
<p>If there are no messages in the channel’s buffer, but the channel has
|
||
not yet been closed, this method will block until a message is sent or
|
||
the channel is closed.</p>
|
||
<p>This method is intended for use cases where you are sending from
|
||
asynchronous code to synchronous code, and will work even if the sender
|
||
is not using <a href="struct.Sender.html#method.blocking_send" title="method tokio::sync::mpsc::Sender::blocking_send"><code>blocking_send</code></a> to send the message.</p>
|
||
<p>Note that if <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>close</code></a> is called, but there are still outstanding
|
||
<a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit"><code>Permits</code></a> from before it was closed, the channel is not considered
|
||
closed by <code>blocking_recv</code> until the permits are released.</p>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<p>This function panics if called within an asynchronous execution
|
||
context.</p>
|
||
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::thread;
|
||
<span class="kw">use </span>tokio::runtime::Runtime;
|
||
<span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel::<u8>(<span class="number">10</span>);
|
||
|
||
<span class="kw">let </span>sync_code = thread::spawn(<span class="kw">move </span>|| {
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="number">10</span>), rx.blocking_recv());
|
||
});
|
||
|
||
Runtime::new()
|
||
.unwrap()
|
||
.block_on(<span class="kw">async move </span>{
|
||
<span class="kw">let _ </span>= tx.send(<span class="number">10</span>).<span class="kw">await</span>;
|
||
});
|
||
sync_code.join().unwrap()
|
||
}</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.blocking_recv_many" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#434-436">Source</a><h4 class="code-header">pub fn <a href="#method.blocking_recv_many" class="fn">blocking_recv_many</a>(&mut self, buffer: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>, limit: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Variant of <a href="struct.Receiver.html#method.recv_many" title="method tokio::sync::mpsc::Receiver::recv_many"><code>Self::recv_many</code></a> for blocking contexts.</p>
|
||
<p>The same conditions as in <a href="struct.Receiver.html#method.blocking_recv" title="method tokio::sync::mpsc::Receiver::blocking_recv"><code>Self::blocking_recv</code></a> apply.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.close" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#478-480">Source</a><h4 class="code-header">pub fn <a href="#method.close" class="fn">close</a>(&mut self)</h4></section></summary><div class="docblock"><p>Closes the receiving half of a channel without dropping it.</p>
|
||
<p>This prevents any further messages from being sent on the channel while
|
||
still enabling the receiver to drain messages that are buffered. Any
|
||
outstanding <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit"><code>Permit</code></a> values will still be able to send messages.</p>
|
||
<p>To guarantee that no messages are dropped, after calling <code>close()</code>,
|
||
<code>recv()</code> must be called until <code>None</code> is returned. If there are
|
||
outstanding <a href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit"><code>Permit</code></a> or <a href="struct.OwnedPermit.html" title="struct tokio::sync::mpsc::OwnedPermit"><code>OwnedPermit</code></a> values, the <code>recv</code> method will
|
||
not return <code>None</code> until those are released.</p>
|
||
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">20</span>);
|
||
|
||
tokio::spawn(<span class="kw">async move </span>{
|
||
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
|
||
<span class="kw">while let </span><span class="prelude-val">Ok</span>(permit) = tx.reserve().<span class="kw">await </span>{
|
||
permit.send(i);
|
||
i += <span class="number">1</span>;
|
||
}
|
||
});
|
||
|
||
rx.close();
|
||
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(msg) = rx.recv().<span class="kw">await </span>{
|
||
<span class="macro">println!</span>(<span class="string">"got {}"</span>, msg);
|
||
}
|
||
|
||
<span class="comment">// Channel closed and no messages are lost.</span></code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.is_closed" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#504-506">Source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fn">is_closed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if a channel is closed.</p>
|
||
<p>This method returns <code>true</code> if the channel has been closed. The channel is closed
|
||
when all <a href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender"><code>Sender</code></a> have been dropped, or when <a href="struct.Receiver.html#method.close" title="method tokio::sync::mpsc::Receiver::close"><code>Receiver::close</code></a> is called.</p>
|
||
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(_tx, <span class="kw-2">mut </span>rx) = mpsc::channel::<()>(<span class="number">10</span>);
|
||
<span class="macro">assert!</span>(!rx.is_closed());
|
||
|
||
rx.close();
|
||
|
||
<span class="macro">assert!</span>(rx.is_closed());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#526-528">Source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if a channel is empty.</p>
|
||
<p>This method returns <code>true</code> if the channel has no messages.</p>
|
||
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, rx) = mpsc::channel(<span class="number">10</span>);
|
||
<span class="macro">assert!</span>(rx.is_empty());
|
||
|
||
tx.send(<span class="number">0</span>).<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert!</span>(!rx.is_empty());
|
||
</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#545-547">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of messages in the channel.</p>
|
||
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, rx) = mpsc::channel(<span class="number">10</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="number">0</span>, rx.len());
|
||
|
||
tx.send(<span class="number">0</span>).<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(<span class="number">1</span>, rx.len());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#591-593">Source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the current capacity of the channel.</p>
|
||
<p>The capacity goes down when the sender sends a value by calling <a href="struct.Sender.html#method.send" title="method tokio::sync::mpsc::Sender::send"><code>Sender::send</code></a> or by reserving
|
||
capacity with <a href="struct.Sender.html#method.reserve" title="method tokio::sync::mpsc::Sender::reserve"><code>Sender::reserve</code></a>. The capacity goes up when values are received.
|
||
This is distinct from <a href="struct.Receiver.html#method.max_capacity" title="method tokio::sync::mpsc::Receiver::max_capacity"><code>max_capacity</code></a>, which always returns buffer capacity initially
|
||
specified when calling <a href="fn.channel.html" title="fn tokio::sync::mpsc::channel"><code>channel</code></a>.</p>
|
||
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = mpsc::channel::<()>(<span class="number">5</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">5</span>);
|
||
|
||
<span class="comment">// Making a reservation drops the capacity by one.
|
||
</span><span class="kw">let </span>permit = tx.reserve().<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(rx.len(), <span class="number">0</span>);
|
||
|
||
<span class="comment">// Sending and receiving a value increases the capacity by one.
|
||
</span>permit.send(());
|
||
<span class="macro">assert_eq!</span>(rx.len(), <span class="number">1</span>);
|
||
rx.recv().<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">5</span>);
|
||
|
||
<span class="comment">// Directly sending a message drops the capacity by one.
|
||
</span>tx.send(()).<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(rx.len(), <span class="number">1</span>);
|
||
|
||
<span class="comment">// Receiving the message increases the capacity by one.
|
||
</span>rx.recv().<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(rx.len(), <span class="number">0</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.max_capacity" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#625-627">Source</a><h4 class="code-header">pub fn <a href="#method.max_capacity" class="fn">max_capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the maximum buffer capacity of the channel.</p>
|
||
<p>The maximum capacity is the buffer capacity initially specified when calling
|
||
<a href="fn.channel.html" title="fn tokio::sync::mpsc::channel"><code>channel</code></a>. This is distinct from <a href="struct.Receiver.html#method.capacity" title="method tokio::sync::mpsc::Receiver::capacity"><code>capacity</code></a>, which returns the <em>current</em>
|
||
available buffer capacity: as messages are sent and received, the value
|
||
returned by <a href="struct.Receiver.html#method.capacity" title="method tokio::sync::mpsc::Receiver::capacity"><code>capacity</code></a> will go up or down, whereas the value
|
||
returned by <a href="struct.Receiver.html#method.max_capacity" title="method tokio::sync::mpsc::Receiver::max_capacity"><code>max_capacity</code></a> will remain constant.</p>
|
||
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc;
|
||
|
||
<span class="kw">let </span>(tx, rx) = mpsc::channel::<()>(<span class="number">5</span>);
|
||
|
||
<span class="comment">// both max capacity and capacity are the same at first
|
||
</span><span class="macro">assert_eq!</span>(rx.max_capacity(), <span class="number">5</span>);
|
||
<span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">5</span>);
|
||
|
||
<span class="comment">// Making a reservation doesn't change the max capacity.
|
||
</span><span class="kw">let </span>permit = tx.reserve().<span class="kw">await</span>.unwrap();
|
||
<span class="macro">assert_eq!</span>(rx.max_capacity(), <span class="number">5</span>);
|
||
<span class="comment">// but drops the capacity by one
|
||
</span><span class="macro">assert_eq!</span>(rx.capacity(), <span class="number">4</span>);</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.poll_recv" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#650-652">Source</a><h4 class="code-header">pub fn <a href="#method.poll_recv" class="fn">poll_recv</a>(&mut self, cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>></h4></section></summary><div class="docblock"><p>Polls to receive the next message on this channel.</p>
|
||
<p>This method returns:</p>
|
||
<ul>
|
||
<li><code>Poll::Pending</code> if no messages are available but the channel is not
|
||
closed, or if a spurious failure happens.</li>
|
||
<li><code>Poll::Ready(Some(message))</code> if a message is available.</li>
|
||
<li><code>Poll::Ready(None)</code> if the channel has been closed and all messages
|
||
sent before it was closed have been received.</li>
|
||
</ul>
|
||
<p>When the method returns <code>Poll::Pending</code>, the <code>Waker</code> in the provided
|
||
<code>Context</code> is scheduled to receive a wakeup when a message is sent on any
|
||
receiver, or when the channel is closed. Note that on multiple calls to
|
||
<code>poll_recv</code> or <code>poll_recv_many</code>, only the <code>Waker</code> from the <code>Context</code>
|
||
passed to the most recent call is scheduled to receive a wakeup.</p>
|
||
<p>If this method returns <code>Poll::Pending</code> due to a spurious failure, then
|
||
the <code>Waker</code> will be notified when the situation causing the spurious
|
||
failure has been resolved. Note that receiving such a wakeup does not
|
||
guarantee that the next call will succeed — it could fail with another
|
||
spurious failure.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.poll_recv_many" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#722-729">Source</a><h4 class="code-header">pub fn <a href="#method.poll_recv_many" class="fn">poll_recv_many</a>(
|
||
&mut self,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
buffer: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>,
|
||
limit: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Polls to receive multiple messages on this channel, extending the provided buffer.</p>
|
||
<p>This method returns:</p>
|
||
<ul>
|
||
<li><code>Poll::Pending</code> if no messages are available but the channel is not closed, or if a
|
||
spurious failure happens.</li>
|
||
<li><code>Poll::Ready(count)</code> where <code>count</code> is the number of messages successfully received and
|
||
stored in <code>buffer</code>. This can be less than, or equal to, <code>limit</code>.</li>
|
||
<li><code>Poll::Ready(0)</code> if <code>limit</code> is set to zero or when the channel is closed.</li>
|
||
</ul>
|
||
<p>When the method returns <code>Poll::Pending</code>, the <code>Waker</code> in the provided
|
||
<code>Context</code> is scheduled to receive a wakeup when a message is sent on any
|
||
receiver, or when the channel is closed. Note that on multiple calls to
|
||
<code>poll_recv</code> or <code>poll_recv_many</code>, only the <code>Waker</code> from the <code>Context</code>
|
||
passed to the most recent call is scheduled to receive a wakeup.</p>
|
||
<p>Note that this method does not guarantee that exactly <code>limit</code> messages
|
||
are received. Rather, if at least one message is available, it returns
|
||
as many messages as it can up to the given limit. This method returns
|
||
zero only if the channel is closed (or if <code>limit</code> is zero).</p>
|
||
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::task::{Context, Poll};
|
||
<span class="kw">use </span>std::pin::Pin;
|
||
<span class="kw">use </span>tokio::sync::mpsc;
|
||
<span class="kw">use </span>futures::Future;
|
||
|
||
<span class="kw">struct </span>MyReceiverFuture<<span class="lifetime">'a</span>> {
|
||
receiver: mpsc::Receiver<i32>,
|
||
buffer: <span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span>Vec<i32>,
|
||
limit: usize,
|
||
}
|
||
|
||
<span class="kw">impl</span><<span class="lifetime">'a</span>> Future <span class="kw">for </span>MyReceiverFuture<<span class="lifetime">'a</span>> {
|
||
<span class="kw">type </span>Output = usize; <span class="comment">// Number of messages received
|
||
|
||
</span><span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> {
|
||
<span class="kw">let </span>MyReceiverFuture { receiver, buffer, limit } = <span class="kw-2">&mut *</span><span class="self">self</span>;
|
||
|
||
<span class="comment">// Now `receiver` and `buffer` are mutable references, and `limit` is copied
|
||
</span><span class="kw">match </span>receiver.poll_recv_many(cx, <span class="kw-2">*</span>buffer, <span class="kw-2">*</span>limit) {
|
||
Poll::Pending => Poll::Pending,
|
||
Poll::Ready(count) => Poll::Ready(count),
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>(tx, rx) = mpsc::channel(<span class="number">32</span>);
|
||
<span class="kw">let </span><span class="kw-2">mut </span>buffer = Vec::new();
|
||
|
||
<span class="kw">let </span>my_receiver_future = MyReceiverFuture {
|
||
receiver: rx,
|
||
buffer: <span class="kw-2">&mut </span>buffer,
|
||
limit: <span class="number">3</span>,
|
||
};
|
||
|
||
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{
|
||
tx.send(i).<span class="kw">await</span>.unwrap();
|
||
}
|
||
|
||
<span class="kw">let </span>count = my_receiver_future.<span class="kw">await</span>;
|
||
<span class="macro">assert_eq!</span>(count, <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(buffer, <span class="macro">vec!</span>[<span class="number">0</span>,<span class="number">1</span>,<span class="number">2</span>])</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.sender_strong_count" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#732-734">Source</a><h4 class="code-header">pub fn <a href="#method.sender_strong_count" class="fn">sender_strong_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of <a href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender"><code>Sender</code></a> handles.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.sender_weak_count" class="method"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#737-739">Source</a><h4 class="code-header">pub fn <a href="#method.sender_weak_count" class="fn">sender_weak_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of <a href="struct.WeakSender.html" title="struct tokio::sync::mpsc::WeakSender"><code>WeakSender</code></a> handles.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#742-748">Source</a><a href="#impl-Debug-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#743-747">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><section id="impl-Unpin-for-Receiver%3CT%3E" class="impl"><a class="src rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#750">Source</a><a href="#impl-Unpin-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Receiver%3CT%3E" class="impl"><a href="#impl-Freeze-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section><section id="impl-RefUnwindSafe-for-Receiver%3CT%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section><section id="impl-Send-for-Receiver%3CT%3E" class="impl"><a href="#impl-Send-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-Receiver%3CT%3E" class="impl"><a href="#impl-Sync-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-UnwindSafe-for-Receiver%3CT%3E" class="impl"><a href="#impl-UnwindSafe-for-Receiver%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::mpsc::Receiver">Receiver</a><T></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |