| <!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 a value from the associated [`Sender`]."><meta name="keywords" content="rust, rustlang, rust-lang, Receiver"><title>Receiver in tokio::sync::oneshot - 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">☰</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.blocking_recv">blocking_recv</a></li><li><a href="#method.close">close</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-Future-for-Receiver%3CT%3E">Future</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-Send-for-Receiver%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Receiver%3CT%3E">Sync</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<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Receiver%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Receiver%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Receiver%3CT%3E">Into<U></a></li><li><a href="#impl-IntoFuture-for-Receiver%3CT%3E">IntoFuture</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Receiver%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Receiver%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::sync::oneshot</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">oneshot</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/oneshot.rs.html#318-326">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Receiver<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Receives a value from the associated <a href="struct.Sender.html" title="Sender"><code>Sender</code></a>.</p> |
| <p>A pair of both a <a href="struct.Sender.html" title="Sender"><code>Sender</code></a> and a <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a> are created by the |
| <a href="fn.channel.html"><code>channel</code></a> function.</p> |
| <p>This channel has no <code>recv</code> method because the receiver itself implements the |
| <a href="trait@std::future::Future"><code>Future</code></a> trait. To receive a <code>Result<T, </code><a href="error/struct.RecvError.html" title="error::RecvError"><code>error::RecvError</code></a><code>></code>, <code>.await</code> the <code>Receiver</code> object directly.</p> |
| <p>The <code>poll</code> method on the <code>Future</code> trait is allowed to spuriously return |
| <code>Poll::Pending</code> even if the message has been sent. If such a spurious |
| failure happens, then the caller will be woken when the spurious failure has |
| been resolved so that the caller can attempt to receive the message again. |
| Note that receiving such a wakeup does not guarantee that the next call will |
| succeed — it could fail with another spurious failure. (A spurious failure |
| does not mean that the message is lost. It is just delayed.)</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::oneshot; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, rx) = oneshot::channel(); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(<span class="kw">_</span>) = tx.send(<span class="number">3</span>) { |
| <span class="macro">println!</span>(<span class="string">"the receiver dropped"</span>); |
| } |
| }); |
| |
| <span class="kw">match </span>rx.<span class="kw">await </span>{ |
| <span class="prelude-val">Ok</span>(v) => <span class="macro">println!</span>(<span class="string">"got = {:?}"</span>, v), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">println!</span>(<span class="string">"the sender dropped"</span>), |
| } |
| }</code></pre></div> |
| <p>If the sender is dropped without sending, the receiver will fail with |
| <a href="error/struct.RecvError.html" title="error::RecvError"><code>error::RecvError</code></a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, rx) = oneshot::channel::<u32>(); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| drop(tx); |
| }); |
| |
| <span class="kw">match </span>rx.<span class="kw">await </span>{ |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => <span class="macro">panic!</span>(<span class="string">"This doesn't happen"</span>), |
| <span class="prelude-val">Err</span>(<span class="kw">_</span>) => <span class="macro">println!</span>(<span class="string">"the sender dropped"</span>), |
| } |
| }</code></pre></div> |
| <p>To use a <code>Receiver</code> in a <code>tokio::select!</code> loop, add <code>&mut</code> in front of the |
| channel.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| <span class="kw">use </span>tokio::time::{interval, sleep, Duration}; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(send, <span class="kw-2">mut </span>recv) = oneshot::channel(); |
| <span class="kw">let </span><span class="kw-2">mut </span>interval = interval(Duration::from_millis(<span class="number">100</span>)); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| sleep(Duration::from_secs(<span class="number">1</span>)).<span class="kw">await</span>; |
| send.send(<span class="string">"shut down"</span>).unwrap(); |
| }); |
| |
| <span class="kw">loop </span>{ |
| <span class="macro">tokio::select! </span>{ |
| <span class="kw">_ </span>= interval.tick() => <span class="macro">println!</span>(<span class="string">"Another 100ms"</span>), |
| msg = <span class="kw-2">&mut </span>recv => { |
| <span class="macro">println!</span>(<span class="string">"Got message: {}"</span>, msg.unwrap()); |
| <span class="kw">break</span>; |
| } |
| } |
| } |
| }</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/oneshot.rs.html#853-1062">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::oneshot::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.close" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/oneshot.rs.html#913-925">source</a><h4 class="code-header">pub fn <a href="#method.close" class="fnname">close</a>(&mut self)</h4></section></summary><div class="docblock"><p>Prevents the associated <a href="struct.Sender.html"><code>Sender</code></a> handle from sending a value.</p> |
| <p>Any <code>send</code> operation which happens after calling <code>close</code> is guaranteed |
| to fail. After calling <code>close</code>, <a href="struct.Receiver.html#method.try_recv"><code>try_recv</code></a> should be called to |
| receive a value if one was sent <strong>before</strong> the call to <code>close</code> |
| completed.</p> |
| <p>This function is useful to perform a graceful shutdown and ensure that a |
| value will not be sent into the channel and never received.</p> |
| <p><code>close</code> is no-op if a message is already received or the channel |
| is already closed.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <p>Prevent a value from being sent</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| <span class="kw">use </span>tokio::sync::oneshot::error::TryRecvError; |
| |
| <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) = oneshot::channel(); |
| |
| <span class="macro">assert!</span>(!tx.is_closed()); |
| |
| rx.close(); |
| |
| <span class="macro">assert!</span>(tx.is_closed()); |
| <span class="macro">assert!</span>(tx.send(<span class="string">"never received"</span>).is_err()); |
| |
| <span class="kw">match </span>rx.try_recv() { |
| <span class="prelude-val">Err</span>(TryRecvError::Closed) => {} |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| }</code></pre></div> |
| <p>Receive a value sent <strong>before</strong> calling <code>close</code></p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| |
| <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) = oneshot::channel(); |
| |
| <span class="macro">assert!</span>(tx.send(<span class="string">"will receive"</span>).is_ok()); |
| |
| rx.close(); |
| |
| <span class="kw">let </span>msg = rx.try_recv().unwrap(); |
| <span class="macro">assert_eq!</span>(msg, <span class="string">"will receive"</span>); |
| }</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/oneshot.rs.html#994-1030">source</a><h4 class="code-header">pub fn <a href="#method.try_recv" class="fnname">try_recv</a>(&mut self) -> Result<T, <a class="enum" href="error/enum.TryRecvError.html" title="enum tokio::sync::oneshot::error::TryRecvError">TryRecvError</a>></h4></section></summary><div class="docblock"><p>Attempts to receive a value.</p> |
| <p>If a pending value exists in the channel, it is returned. If no value |
| has been sent, the current task <strong>will not</strong> be registered for |
| future notification.</p> |
| <p>This function is useful to call from outside the context of an |
| asynchronous task.</p> |
| <p>Note that unlike the <code>poll</code> method, the <code>try_recv</code> method cannot fail |
| spuriously. Any send or close event that happens before this call to |
| <code>try_recv</code> will be correctly returned to the caller.</p> |
| <h5 id="return"><a href="#return">Return</a></h5> |
| <ul> |
| <li><code>Ok(T)</code> if a value is pending in the channel.</li> |
| <li><code>Err(TryRecvError::Empty)</code> if no value has been sent yet.</li> |
| <li><code>Err(TryRecvError::Closed)</code> if the sender has dropped without sending |
| a value, or if the message has already been received.</li> |
| </ul> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <p><code>try_recv</code> before a value is sent, then after.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| <span class="kw">use </span>tokio::sync::oneshot::error::TryRecvError; |
| |
| <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) = oneshot::channel(); |
| |
| <span class="kw">match </span>rx.try_recv() { |
| <span class="comment">// The channel is currently empty |
| </span><span class="prelude-val">Err</span>(TryRecvError::Empty) => {} |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| |
| <span class="comment">// Send a value |
| </span>tx.send(<span class="string">"hello"</span>).unwrap(); |
| |
| <span class="kw">match </span>rx.try_recv() { |
| <span class="prelude-val">Ok</span>(value) => <span class="macro">assert_eq!</span>(value, <span class="string">"hello"</span>), |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| }</code></pre></div> |
| <p><code>try_recv</code> when the sender dropped before sending a value</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::oneshot; |
| <span class="kw">use </span>tokio::sync::oneshot::error::TryRecvError; |
| |
| <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) = oneshot::channel::<()>(); |
| |
| drop(tx); |
| |
| <span class="kw">match </span>rx.try_recv() { |
| <span class="comment">// The channel will never receive a value. |
| </span><span class="prelude-val">Err</span>(TryRecvError::Closed) => {} |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(), |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.blocking_recv" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/oneshot.rs.html#1059-1061">source</a><h4 class="code-header">pub fn <a href="#method.blocking_recv" class="fnname">blocking_recv</a>(self) -> Result<T, <a class="struct" href="error/struct.RecvError.html" title="struct tokio::sync::oneshot::error::RecvError">RecvError</a>></h4></section></summary><div class="docblock"><p>Blocking receive to call outside of asynchronous contexts.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This function panics if called within an asynchronous execution |
| context.</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>std::thread; |
| <span class="kw">use </span>tokio::sync::oneshot; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx, rx) = oneshot::channel::<u8>(); |
| |
| <span class="kw">let </span>sync_code = thread::spawn(<span class="kw">move </span>|| { |
| <span class="macro">assert_eq!</span>(<span class="prelude-val">Ok</span>(<span class="number">10</span>), rx.blocking_recv()); |
| }); |
| |
| <span class="kw">let _ </span>= tx.send(<span class="number">10</span>); |
| sync_code.join().unwrap(); |
| }</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/oneshot.rs.html#317">source</a><a href="#impl-Debug-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: Debug> Debug for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></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/oneshot.rs.html#317">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> 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/oneshot.rs.html#1064-1078">source</a><a href="#impl-Drop-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Drop for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></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/oneshot.rs.html#1065-1077">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a class="fnname">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Future-for-Receiver%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/oneshot.rs.html#1080-1107">source</a><a href="#impl-Future-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Future for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = Result<T, <a class="struct" href="error/struct.RecvError.html" title="struct tokio::sync::oneshot::error::RecvError">RecvError</a>></h4></section></summary><div class='docblock'>The type of value produced on completion.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/oneshot.rs.html#1083-1106">source</a><a href="#method.poll" class="anchor"></a><h4 class="code-header">fn <a class="fnname">poll</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output></h4></section></summary><div class='docblock'>Attempt to resolve the future to a final value, registering |
| the current task for wakeup if the value is not yet available. <a>Read more</a></div></details></div></details></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<T> !RefUnwindSafe for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></h3></section><section id="impl-Send-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T><span class="where fmt-newline">where<br> T: Send,</span></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<T> Unpin for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></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<T> !UnwindSafe for <a class="struct" href="struct.Receiver.html" title="struct tokio::sync::oneshot::Receiver">Receiver</a><T></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<T> Any for T<span class="where fmt-newline">where<br> 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>(&self) -> 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<T> Borrow<T> for T<span class="where fmt-newline">where<br> 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>(&self) -> &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<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> 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>(&mut self) -> &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<T> From<T> 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) -> 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<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</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) -> 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]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoFuture-for-Receiver%3CT%3E" class="impl has-srclink"><a href="#impl-IntoFuture-for-Receiver%3CT%3E" class="anchor"></a><h3 class="code-header">impl<F> IntoFuture for F<span class="where fmt-newline">where<br> F: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <F as Future>::Output</h4></section></summary><div class='docblock'>The output that the future will produce on completion.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.IntoFuture" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.IntoFuture" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">IntoFuture</a> = F</h4></section></summary><div class='docblock'>Which kind of future are we turning this into?</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_future" class="method trait-impl has-srclink"><a href="#method.into_future" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_future</a>(self) -> <F as IntoFuture>::IntoFuture</h4></section></summary><div class='docblock'>Creates a future from a value. <a>Read more</a></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<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</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) -> Result<T, <T as TryFrom<U>>::Error></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<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</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> = <U as TryFrom<T>>::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) -> Result<U, <U as TryFrom<T>>::Error></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> |
