blob: 127d76b78d613adef3c017aaf9bafab3842f6959 [file] [log] [blame]
<!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="Receiving-half of the `broadcast` channel."><meta name="keywords" content="rust, rustlang, rust-lang, Receiver"><title>Receiver in tokio::sync::broadcast - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Receiver</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.len">len</a></li><li><a href="#method.recv">recv</a></li><li><a href="#method.resubscribe">resubscribe</a></li><li><a href="#method.try_recv">try_recv</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-Receiver%3CT%3E">Debug</a></li><li><a href="#impl-Drop-for-Receiver%3CT%3E">Drop</a></li><li><a href="#impl-Send-for-Receiver%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Receiver%3CT%3E">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-Receiver%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Receiver%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Receiver%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Receiver%3CT%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Receiver%3CT%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Receiver%3CT%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Receiver%3CT%3E">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Receiver%3CT%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Receiver%3CT%3E">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In tokio::sync::broadcast</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../../index.html">tokio</a>::<wbr><a href="../index.html">sync</a>::<wbr><a href="index.html">broadcast</a>::<wbr><a class="struct" href="#">Receiver</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../../src/tokio/sync/broadcast.rs.html#200-206">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Receiver&lt;T&gt; { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Receiving-half of the <a href="index.html"><code>broadcast</code></a> channel.</p>
<p>Must not be used concurrently. Messages may be retrieved using
<a href="struct.Receiver.html#method.recv" title="Receiver::recv"><code>recv</code></a>.</p>
<p>To turn this receiver into a <code>Stream</code>, you can use the <a href="https://docs.rs/tokio-stream/0.1/tokio_stream/wrappers/struct.BroadcastStream.html"><code>BroadcastStream</code></a>
wrapper.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx1) = broadcast::channel(<span class="number">16</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rx2 = tx.subscribe();
tokio::spawn(<span class="kw">async move </span>{
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
});
tokio::spawn(<span class="kw">async move </span>{
<span class="macro">assert_eq!</span>(rx2.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx2.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
});
tx.send(<span class="number">10</span>).unwrap();
tx.send(<span class="number">20</span>).unwrap();
}</code></pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#704-867">source</a><a href="#impl-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#738-741">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fnname">len</a>(&amp;self) -&gt; usize</h4></section></summary><div class="docblock"><p>Returns the number of messages that were sent into the channel and that
this <a href="struct.Receiver.html"><code>Receiver</code></a> has yet to receive.</p>
<p>If the returned value from <code>len</code> is larger than the next largest power of 2
of the capacity of the channel any call to <a href="struct.Receiver.html#method.recv"><code>recv</code></a> will return an
<code>Err(RecvError::Lagged)</code> and any call to <a href="struct.Receiver.html#method.try_recv"><code>try_recv</code></a> will return an
<code>Err(TryRecvError::Lagged)</code>, e.g. if the capacity of the channel is 10,
<a href="struct.Receiver.html#method.recv"><code>recv</code></a> will start to return <code>Err(RecvError::Lagged)</code> once <code>len</code> returns
values larger than 16.</p>
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx1) = broadcast::channel(<span class="number">16</span>);
tx.send(<span class="number">10</span>).unwrap();
tx.send(<span class="number">20</span>).unwrap();
<span class="macro">assert_eq!</span>(rx1.len(), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx1.len(), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
<span class="macro">assert_eq!</span>(rx1.len(), <span class="number">0</span>);
}</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#768-770">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&amp;self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns true if there aren’t any messages in the channel that the <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a>
has yet to receive.</p>
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx1) = broadcast::channel(<span class="number">16</span>);
<span class="macro">assert!</span>(rx1.is_empty());
tx.send(<span class="number">10</span>).unwrap();
tx.send(<span class="number">20</span>).unwrap();
<span class="macro">assert!</span>(!rx1.is_empty());
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
<span class="macro">assert!</span>(rx1.is_empty());
}</code></pre></div>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Receiver%3CT%3E-1" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#869-1018">source</a><a href="#impl-Receiver%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Clone&gt; <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.resubscribe" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#893-896">source</a><h4 class="code-header">pub fn <a href="#method.resubscribe" class="fnname">resubscribe</a>(&amp;self) -&gt; Self</h4></section></summary><div class="docblock"><p>Re-subscribes to the channel starting from the current tail element.</p>
<p>This <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a> handle will receive a clone of all values sent
<strong>after</strong> it has resubscribed. This will not include elements that are
in the queue of the current receiver. Consider the following example.</p>
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = broadcast::channel(<span class="number">2</span>);
tx.send(<span class="number">1</span>).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>rx2 = rx.resubscribe();
tx.send(<span class="number">2</span>).unwrap();
<span class="macro">assert_eq!</span>(rx2.recv().<span class="kw">await</span>.unwrap(), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">1</span>);
}</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.recv" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#969-972">source</a><h4 class="code-header">pub async fn <a href="#method.recv" class="fnname">recv</a>(&amp;mut self) -&gt; Result&lt;T, <a class="enum" href="error/enum.RecvError.html" title="enum tokio::sync::broadcast::error::RecvError">RecvError</a>&gt;</h4></section></summary><div class="docblock"><p>Receives the next value for this receiver.</p>
<p>Each <a href="struct.Receiver.html"><code>Receiver</code></a> handle will receive a clone of all values sent
<strong>after</strong> it has subscribed.</p>
<p><code>Err(RecvError::Closed)</code> is returned when all <code>Sender</code> halves have
dropped, indicating that no further values can be sent on the channel.</p>
<p>If the <a href="struct.Receiver.html"><code>Receiver</code></a> handle falls behind, once the channel is full, newly
sent values will overwrite old values. At this point, a call to <a href="struct.Receiver.html#method.recv"><code>recv</code></a>
will return with <code>Err(RecvError::Lagged)</code> and the <a href="struct.Receiver.html"><code>Receiver</code></a>’s
internal cursor is updated to point to the oldest value still held by
the channel. A subsequent call to <a href="struct.Receiver.html#method.recv"><code>recv</code></a> will return this value
<strong>unless</strong> it has been since overwritten.</p>
<h5 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h5>
<p>This method is cancel safe. If <code>recv</code> is used as the event in a
<a href="../../macro.select.html"><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-4"><a href="#examples-4">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx1) = broadcast::channel(<span class="number">16</span>);
<span class="kw">let </span><span class="kw-2">mut </span>rx2 = tx.subscribe();
tokio::spawn(<span class="kw">async move </span>{
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx1.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
});
tokio::spawn(<span class="kw">async move </span>{
<span class="macro">assert_eq!</span>(rx2.recv().<span class="kw">await</span>.unwrap(), <span class="number">10</span>);
<span class="macro">assert_eq!</span>(rx2.recv().<span class="kw">await</span>.unwrap(), <span class="number">20</span>);
});
tx.send(<span class="number">10</span>).unwrap();
tx.send(<span class="number">20</span>).unwrap();
}</code></pre></div>
<p>Handling lag</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = broadcast::channel(<span class="number">2</span>);
tx.send(<span class="number">10</span>).unwrap();
tx.send(<span class="number">20</span>).unwrap();
tx.send(<span class="number">30</span>).unwrap();
<span class="comment">// The receiver lagged behind
</span><span class="macro">assert!</span>(rx.recv().<span class="kw">await</span>.is_err());
<span class="comment">// At this point, we can abort or continue with lost messages
</span><span class="macro">assert_eq!</span>(<span class="number">20</span>, rx.recv().<span class="kw">await</span>.unwrap());
<span class="macro">assert_eq!</span>(<span class="number">30</span>, rx.recv().<span class="kw">await</span>.unwrap());
}</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_recv" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#1014-1017">source</a><h4 class="code-header">pub fn <a href="#method.try_recv" class="fnname">try_recv</a>(&amp;mut self) -&gt; Result&lt;T, <a class="enum" href="error/enum.TryRecvError.html" title="enum tokio::sync::broadcast::error::TryRecvError">TryRecvError</a>&gt;</h4></section></summary><div class="docblock"><p>Attempts to return a pending value on this receiver without awaiting.</p>
<p>This is useful for a flavor of “optimistic check” before deciding to
await on a receiver.</p>
<p>Compared with <a href="struct.Receiver.html#method.recv"><code>recv</code></a>, this function has three failure cases instead of two
(one for closed, one for an empty buffer, one for a lagging receiver).</p>
<p><code>Err(TryRecvError::Closed)</code> is returned when all <code>Sender</code> halves have
dropped, indicating that no further values can be sent on the channel.</p>
<p>If the <a href="struct.Receiver.html"><code>Receiver</code></a> handle falls behind, once the channel is full, newly
sent values will overwrite old values. At this point, a call to <a href="struct.Receiver.html#method.recv"><code>recv</code></a>
will return with <code>Err(TryRecvError::Lagged)</code> and the <a href="struct.Receiver.html"><code>Receiver</code></a>’s
internal cursor is updated to point to the oldest value still held by
the channel. A subsequent call to <a href="struct.Receiver.html#method.try_recv"><code>try_recv</code></a> will return this value
<strong>unless</strong> it has been since overwritten. If there are no values to
receive, <code>Err(TryRecvError::Empty)</code> is returned.</p>
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::broadcast;
<span class="attribute">#[tokio::main]
</span><span class="kw">async fn </span>main() {
<span class="kw">let </span>(tx, <span class="kw-2">mut </span>rx) = broadcast::channel(<span class="number">16</span>);
<span class="macro">assert!</span>(rx.try_recv().is_err());
tx.send(<span class="number">10</span>).unwrap();
<span class="kw">let </span>value = rx.try_recv().unwrap();
<span class="macro">assert_eq!</span>(<span class="number">10</span>, value);
}</code></pre></div>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#1138-1142">source</a><a href="#impl-Debug-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Debug for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#1139-1141">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, fmt: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Drop-for-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#1020-1041">source</a><a href="#impl-Drop-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Drop for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#1021-1040">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a class="fnname">drop</a>(&amp;mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details><section id="impl-Send-for-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#484">source</a><a href="#impl-Send-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Send&gt; Send for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section><section id="impl-Sync-for-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/broadcast.rs.html#485">source</a><a href="#impl-Sync-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T:&nbsp;Send&gt; Sync for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; !RefUnwindSafe for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section><section id="impl-Unpin-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Unpin for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section><section id="impl-UnwindSafe-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; !UnwindSafe for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::broadcast::Receiver">Receiver</a>&lt;T&gt;</h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; 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>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>