| <!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="Sends values to the associated `Receiver`."><meta name="keywords" content="rust, rustlang, rust-lang, Sender"><title>Sender in tokio::sync::mpsc - 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="#">Sender</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.blocking_send">blocking_send</a></li><li><a href="#method.capacity">capacity</a></li><li><a href="#method.closed">closed</a></li><li><a href="#method.downgrade">downgrade</a></li><li><a href="#method.is_closed">is_closed</a></li><li><a href="#method.max_capacity">max_capacity</a></li><li><a href="#method.reserve">reserve</a></li><li><a href="#method.reserve_owned">reserve_owned</a></li><li><a href="#method.same_channel">same_channel</a></li><li><a href="#method.send">send</a></li><li><a href="#method.send_timeout">send_timeout</a></li><li><a href="#method.try_reserve">try_reserve</a></li><li><a href="#method.try_reserve_owned">try_reserve_owned</a></li><li><a href="#method.try_send">try_send</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Sender%3CT%3E">Clone</a></li><li><a href="#impl-Debug-for-Sender%3CT%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Sender%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-Sender%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Sender%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Sender%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Sender%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Sender%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Sender%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Sender%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-Sender%3CT%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Sender%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::sync::mpsc</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">mpsc</a>::<wbr><a class="struct" href="#">Sender</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/mpsc/bounded.rs.html#22-24">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 Sender<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>Sends values to the associated <code>Receiver</code>.</p> |
| <p>Instances are created by the <a href="fn.channel.html"><code>channel</code></a> function.</p> |
| <p>To convert the <code>Sender</code> into a <code>Sink</code> or use it in a poll function, you can |
| use the <a href="https://docs.rs/tokio-util/0.6/tokio_util/sync/struct.PollSender.html"><code>PollSender</code></a> utility.</p> |
| </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-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#414-1088">source</a><a href="#impl-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#474-482">source</a><h4 class="code-header">pub async fn <a href="#method.send" class="fnname">send</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><T>></h4></section></summary><div class="docblock"><p>Sends a value, waiting until there is capacity.</p> |
| <p>A successful send occurs when it is determined that the other end of the |
| channel has not hung up already. An unsuccessful send would be one where |
| the corresponding receiver has already been closed. Note that a return |
| value of <code>Err</code> means that the data will never be received, but a return |
| value of <code>Ok</code> does not mean that the data will be received. It is |
| possible for the corresponding receiver to hang up immediately after |
| this function returns <code>Ok</code>.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>If the receive half of the channel is closed, either due to <a href="struct.Receiver.html#method.close"><code>close</code></a> |
| being called or the <a href="struct.Receiver.html"><code>Receiver</code></a> handle dropping, the function returns |
| an error. The error includes the value passed to <code>send</code>.</p> |
| <h5 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h5> |
| <p>If <code>send</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, then it is guaranteed |
| that the message was not sent.</p> |
| <p>This channel uses a queue to ensure that calls to <code>send</code> and <code>reserve</code> |
| complete in the order they were requested. Cancelling a call to |
| <code>send</code> makes you lose your place in the queue.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <p>In the following example, each call to <code>send</code> will block until the |
| previously sent value was received.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(<span class="kw">_</span>) = tx.send(i).<span class="kw">await </span>{ |
| <span class="macro">println!</span>(<span class="string">"receiver dropped"</span>); |
| <span class="kw">return</span>; |
| } |
| } |
| }); |
| |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(i) = rx.recv().<span class="kw">await </span>{ |
| <span class="macro">println!</span>(<span class="string">"got = {}"</span>, i); |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.closed" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#520-522">source</a><h4 class="code-header">pub async fn <a href="#method.closed" class="fnname">closed</a>(&self)</h4></section></summary><div class="docblock"><p>Completes when the receiver has dropped.</p> |
| <p>This allows the producers to get notified when interest in the produced |
| values is canceled and immediately stop doing work.</p> |
| <h5 id="cancel-safety-1"><a href="#cancel-safety-1">Cancel safety</a></h5> |
| <p>This method is cancel safe. Once the channel is closed, it stays closed |
| forever and all future calls to <code>closed</code> will return immediately.</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::mpsc; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span>(tx1, rx) = mpsc::channel::<()>(<span class="number">1</span>); |
| <span class="kw">let </span>tx2 = tx1.clone(); |
| <span class="kw">let </span>tx3 = tx1.clone(); |
| <span class="kw">let </span>tx4 = tx1.clone(); |
| <span class="kw">let </span>tx5 = tx1.clone(); |
| tokio::spawn(<span class="kw">async move </span>{ |
| drop(rx); |
| }); |
| |
| <span class="macro">futures::join!</span>( |
| tx1.closed(), |
| tx2.closed(), |
| tx3.closed(), |
| tx4.closed(), |
| tx5.closed() |
| ); |
| <span class="macro">println!</span>(<span class="string">"Receiver dropped"</span>); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_send" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#582-592">source</a><h4 class="code-header">pub fn <a href="#method.try_send" class="fnname">try_send</a>(&self, message: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.TrySendError.html" title="enum tokio::sync::mpsc::error::TrySendError">TrySendError</a><T>></h4></section></summary><div class="docblock"><p>Attempts to immediately send a message on this <code>Sender</code></p> |
| <p>This method differs from <a href="struct.Sender.html#method.send"><code>send</code></a> by returning immediately if the channel’s |
| buffer is full or no receiver is waiting to acquire some data. Compared |
| with <a href="struct.Sender.html#method.send"><code>send</code></a>, this function has two failure cases instead of one (one for |
| disconnection, one for a full buffer).</p> |
| <h5 id="errors-1"><a href="#errors-1">Errors</a></h5> |
| <p>If the channel capacity has been reached, i.e., the channel has <code>n</code> |
| buffered values where <code>n</code> is the argument passed to <a href="fn.channel.html"><code>channel</code></a>, then an |
| error is returned.</p> |
| <p>If the receive half of the channel is closed, either due to <a href="struct.Receiver.html#method.close"><code>close</code></a> |
| being called or the <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a> handle dropping, the function returns |
| an error. The error includes the value passed to <code>send</code>.</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::mpsc; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="comment">// Create a channel with buffer size 1 |
| </span><span class="kw">let </span>(tx1, <span class="kw-2">mut </span>rx) = mpsc::channel(<span class="number">1</span>); |
| <span class="kw">let </span>tx2 = tx1.clone(); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| tx1.send(<span class="number">1</span>).<span class="kw">await</span>.unwrap(); |
| tx1.send(<span class="number">2</span>).<span class="kw">await</span>.unwrap(); |
| <span class="comment">// task waits until the receiver receives a value. |
| </span>}); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="comment">// This will return an error and send |
| // no message if the buffer is full |
| </span><span class="kw">let _ </span>= tx2.try_send(<span class="number">3</span>); |
| }); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>msg; |
| msg = rx.recv().<span class="kw">await</span>.unwrap(); |
| <span class="macro">println!</span>(<span class="string">"message {} received"</span>, msg); |
| |
| msg = rx.recv().<span class="kw">await</span>.unwrap(); |
| <span class="macro">println!</span>(<span class="string">"message {} received"</span>, msg); |
| |
| <span class="comment">// Third message may have never been sent |
| </span><span class="kw">match </span>rx.recv().<span class="kw">await </span>{ |
| <span class="prelude-val">Some</span>(msg) => <span class="macro">println!</span>(<span class="string">"message {} received"</span>, msg), |
| <span class="prelude-val">None </span>=> <span class="macro">println!</span>(<span class="string">"the third message was never sent"</span>), |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_timeout" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#646-663">source</a><h4 class="code-header">pub async fn <a href="#method.send_timeout" class="fnname">send_timeout</a>(<br> &self,<br> value: T,<br> timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="error/enum.SendTimeoutError.html" title="enum tokio::sync::mpsc::error::SendTimeoutError">SendTimeoutError</a><T>></h4></section></summary><div class="docblock"><p>Sends a value, waiting until there is capacity, but only for a limited time.</p> |
| <p>Shares the same success and error conditions as <a href="struct.Sender.html#method.send"><code>send</code></a>, adding one more |
| condition for an unsuccessful send, which is when the provided timeout has |
| elapsed, and there is no capacity available.</p> |
| <h5 id="errors-2"><a href="#errors-2">Errors</a></h5> |
| <p>If the receive half of the channel is closed, either due to <a href="struct.Receiver.html#method.close"><code>close</code></a> |
| being called or the <a href="struct.Receiver.html"><code>Receiver</code></a> having been dropped, |
| the function returns an error. The error includes the value passed to <code>send</code>.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This function panics if it is called outside the context of a Tokio |
| runtime <a href="../../runtime/struct.Builder.html#method.enable_time">with time enabled</a>.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <p>In the following example, each call to <code>send_timeout</code> will block until the |
| previously sent value was received, unless the timeout has elapsed.</p> |
| |
| <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::time::{sleep, Duration}; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| tokio::spawn(<span class="kw">async move </span>{ |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = tx.send_timeout(i, Duration::from_millis(<span class="number">100</span>)).<span class="kw">await </span>{ |
| <span class="macro">println!</span>(<span class="string">"send error: #{:?}"</span>, e); |
| <span class="kw">return</span>; |
| } |
| } |
| }); |
| |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(i) = rx.recv().<span class="kw">await </span>{ |
| <span class="macro">println!</span>(<span class="string">"got = {}"</span>, i); |
| sleep(Duration::from_millis(<span class="number">200</span>)).<span class="kw">await</span>; |
| } |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.blocking_send" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#701-703">source</a><h4 class="code-header">pub fn <a href="#method.blocking_send" class="fnname">blocking_send</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><T>></h4></section></summary><div class="docblock"><p>Blocking send to call outside of asynchronous contexts.</p> |
| <p>This method is intended for use cases where you are sending from |
| synchronous code to asynchronous code, and will work even if the |
| receiver is not using <a href="struct.Receiver.html#method.blocking_recv"><code>blocking_recv</code></a> to receive the message.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>This function panics if called within an asynchronous execution |
| context.</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>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">1</span>); |
| |
| <span class="kw">let </span>sync_code = thread::spawn(<span class="kw">move </span>|| { |
| tx.blocking_send(<span class="number">10</span>).unwrap(); |
| }); |
| |
| Runtime::new().unwrap().block_on(<span class="kw">async move </span>{ |
| <span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="number">10</span>), rx.recv().<span class="kw">await</span>); |
| }); |
| sync_code.join().unwrap() |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_closed" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#723-725">source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fnname">is_closed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if the channel has been closed. This happens when the |
| <a href="struct.Receiver.html"><code>Receiver</code></a> is dropped, or when the <a href="struct.Receiver.html#method.close"><code>Receiver::close</code></a> method is |
| called.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>(tx, rx) = tokio::sync::mpsc::channel::<()>(<span class="number">42</span>); |
| <span class="macro">assert!</span>(!tx.is_closed()); |
| |
| <span class="kw">let </span>tx2 = tx.clone(); |
| <span class="macro">assert!</span>(!tx2.is_closed()); |
| |
| drop(rx); |
| <span class="macro">assert!</span>(tx.is_closed()); |
| <span class="macro">assert!</span>(tx2.is_closed());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reserve" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#771-774">source</a><h4 class="code-header">pub async fn <a href="#method.reserve" class="fnname">reserve</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit">Permit</a><'_, T>, <a class="struct" href="error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></h4></section></summary><div class="docblock"><p>Waits for channel capacity. Once capacity to send one message is |
| available, it is reserved for the caller.</p> |
| <p>If the channel is full, the function waits for the number of unreceived |
| messages to become less than the channel capacity. Capacity to send one |
| message is reserved for the caller. A <a href="struct.Permit.html"><code>Permit</code></a> is returned to track |
| the reserved capacity. The <a href="struct.Permit.html#method.send"><code>send</code></a> function on <a href="struct.Permit.html"><code>Permit</code></a> consumes the |
| reserved capacity.</p> |
| <p>Dropping <a href="struct.Permit.html"><code>Permit</code></a> without sending a message releases the capacity back |
| to the channel.</p> |
| <h5 id="cancel-safety-2"><a href="#cancel-safety-2">Cancel safety</a></h5> |
| <p>This channel uses a queue to ensure that calls to <code>send</code> and <code>reserve</code> |
| complete in the order they were requested. Cancelling a call to |
| <code>reserve</code> makes you lose your place in the queue.</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::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| <span class="comment">// Reserve capacity |
| </span><span class="kw">let </span>permit = tx.reserve().<span class="kw">await</span>.unwrap(); |
| |
| <span class="comment">// Trying to send directly on the `tx` will fail due to no |
| // available capacity. |
| </span><span class="macro">assert!</span>(tx.try_send(<span class="number">123</span>).is_err()); |
| |
| <span class="comment">// Sending on the permit succeeds |
| </span>permit.send(<span class="number">456</span>); |
| |
| <span class="comment">// The value sent on the permit is received |
| </span><span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">456</span>); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reserve_owned" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#856-861">source</a><h4 class="code-header">pub async fn <a href="#method.reserve_owned" class="fnname">reserve_owned</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.OwnedPermit.html" title="struct tokio::sync::mpsc::OwnedPermit">OwnedPermit</a><T>, <a class="struct" href="error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></h4></section></summary><div class="docblock"><p>Waits for channel capacity, moving the <code>Sender</code> and returning an owned |
| permit. Once capacity to send one message is available, it is reserved |
| for the caller.</p> |
| <p>This moves the sender <em>by value</em>, and returns an owned permit that can |
| be used to send a message into the channel. Unlike <a href="struct.Sender.html#method.reserve"><code>Sender::reserve</code></a>, |
| this method may be used in cases where the permit must be valid for the |
| <code>'static</code> lifetime. <code>Sender</code>s may be cloned cheaply (<code>Sender::clone</code> is |
| essentially a reference count increment, comparable to <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html#method.clone"><code>Arc::clone</code></a>), |
| so when multiple <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a>s are needed or the <code>Sender</code> cannot be |
| moved, it can be cloned prior to calling <code>reserve_owned</code>.</p> |
| <p>If the channel is full, the function waits for the number of unreceived |
| messages to become less than the channel capacity. Capacity to send one |
| message is reserved for the caller. An <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a> is returned to |
| track the reserved capacity. The <a href="struct.OwnedPermit.html#method.send"><code>send</code></a> function on <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a> |
| consumes the reserved capacity.</p> |
| <p>Dropping the <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a> without sending a message releases the |
| capacity back to the channel.</p> |
| <h5 id="cancel-safety-3"><a href="#cancel-safety-3">Cancel safety</a></h5> |
| <p>This channel uses a queue to ensure that calls to <code>send</code> and <code>reserve</code> |
| complete in the order they were requested. Cancelling a call to |
| <code>reserve_owned</code> makes you lose your place in the queue.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <p>Sending a message using an <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| <span class="comment">// Reserve capacity, moving the sender. |
| </span><span class="kw">let </span>permit = tx.reserve_owned().<span class="kw">await</span>.unwrap(); |
| |
| <span class="comment">// Send a message, consuming the permit and returning |
| // the moved sender. |
| </span><span class="kw">let </span>tx = permit.send(<span class="number">123</span>); |
| |
| <span class="comment">// The value sent on the permit is received. |
| </span><span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">123</span>); |
| |
| <span class="comment">// The sender can now be used again. |
| </span>tx.send(<span class="number">456</span>).<span class="kw">await</span>.unwrap(); |
| }</code></pre></div> |
| <p>When multiple <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a>s are needed, or the sender cannot be moved |
| by value, it can be inexpensively cloned before calling <code>reserve_owned</code>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| <span class="comment">// Clone the sender and reserve capacity. |
| </span><span class="kw">let </span>permit = tx.clone().reserve_owned().<span class="kw">await</span>.unwrap(); |
| |
| <span class="comment">// Trying to send directly on the `tx` will fail due to no |
| // available capacity. |
| </span><span class="macro">assert!</span>(tx.try_send(<span class="number">123</span>).is_err()); |
| |
| <span class="comment">// Sending on the permit succeeds. |
| </span>permit.send(<span class="number">456</span>); |
| |
| <span class="comment">// The value sent on the permit is received |
| </span><span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">456</span>); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_reserve" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#913-921">source</a><h4 class="code-header">pub fn <a href="#method.try_reserve" class="fnname">try_reserve</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.Permit.html" title="struct tokio::sync::mpsc::Permit">Permit</a><'_, T>, <a class="enum" href="error/enum.TrySendError.html" title="enum tokio::sync::mpsc::error::TrySendError">TrySendError</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>></h4></section></summary><div class="docblock"><p>Tries to acquire a slot in the channel without waiting for the slot to become |
| available.</p> |
| <p>If the channel is full this function will return <a href="error/enum.TrySendError.html" title="TrySendError"><code>TrySendError</code></a>, otherwise |
| if there is a slot available it will return a <a href="struct.Permit.html"><code>Permit</code></a> that will then allow you |
| to <a href="struct.Permit.html#method.send"><code>send</code></a> on the channel with a guaranteed slot. This function is similar to |
| <a href="struct.Sender.html#method.reserve"><code>reserve</code></a> except it does not await for the slot to become available.</p> |
| <p>Dropping <a href="struct.Permit.html"><code>Permit</code></a> without sending a message releases the capacity back |
| to the channel.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| <span class="comment">// Reserve capacity |
| </span><span class="kw">let </span>permit = tx.try_reserve().unwrap(); |
| |
| <span class="comment">// Trying to send directly on the `tx` will fail due to no |
| // available capacity. |
| </span><span class="macro">assert!</span>(tx.try_send(<span class="number">123</span>).is_err()); |
| |
| <span class="comment">// Trying to reserve an additional slot on the `tx` will |
| // fail because there is no capacity. |
| </span><span class="macro">assert!</span>(tx.try_reserve().is_err()); |
| |
| <span class="comment">// Sending on the permit succeeds |
| </span>permit.send(<span class="number">456</span>); |
| |
| <span class="comment">// The value sent on the permit is received |
| </span><span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">456</span>); |
| |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_reserve_owned" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#978-988">source</a><h4 class="code-header">pub fn <a href="#method.try_reserve_owned" class="fnname">try_reserve_owned</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.OwnedPermit.html" title="struct tokio::sync::mpsc::OwnedPermit">OwnedPermit</a><T>, <a class="enum" href="error/enum.TrySendError.html" title="enum tokio::sync::mpsc::error::TrySendError">TrySendError</a><Self>></h4></section></summary><div class="docblock"><p>Tries to acquire a slot in the channel without waiting for the slot to become |
| available, returning an owned permit.</p> |
| <p>This moves the sender <em>by value</em>, and returns an owned permit that can |
| be used to send a message into the channel. Unlike <a href="struct.Sender.html#method.try_reserve" title="Sender::try_reserve"><code>Sender::try_reserve</code></a>, |
| this method may be used in cases where the permit must be valid for the |
| <code>'static</code> lifetime. <code>Sender</code>s may be cloned cheaply (<code>Sender::clone</code> is |
| essentially a reference count increment, comparable to <a href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html#method.clone"><code>Arc::clone</code></a>), |
| so when multiple <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a>s are needed or the <code>Sender</code> cannot be |
| moved, it can be cloned prior to calling <code>try_reserve_owned</code>.</p> |
| <p>If the channel is full this function will return a <a href="error/enum.TrySendError.html" title="TrySendError"><code>TrySendError</code></a>. |
| Since the sender is taken by value, the <code>TrySendError</code> returned in this |
| case contains the sender, so that it may be used again. Otherwise, if |
| there is a slot available, this method will return an <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a> |
| that can then be used to <a href="struct.OwnedPermit.html#method.send"><code>send</code></a> on the channel with a guaranteed slot. |
| This function is similar to <a href="struct.Sender.html#method.reserve_owned"><code>reserve_owned</code></a> except it does not await |
| for the slot to become available.</p> |
| <p>Dropping the <a href="struct.OwnedPermit.html"><code>OwnedPermit</code></a> without sending a message releases the capacity back |
| to the channel.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel(<span class="number">1</span>); |
| |
| <span class="comment">// Reserve capacity |
| </span><span class="kw">let </span>permit = tx.clone().try_reserve_owned().unwrap(); |
| |
| <span class="comment">// Trying to send directly on the `tx` will fail due to no |
| // available capacity. |
| </span><span class="macro">assert!</span>(tx.try_send(<span class="number">123</span>).is_err()); |
| |
| <span class="comment">// Trying to reserve an additional slot on the `tx` will |
| // fail because there is no capacity. |
| </span><span class="macro">assert!</span>(tx.try_reserve().is_err()); |
| |
| <span class="comment">// Sending on the permit succeeds |
| </span>permit.send(<span class="number">456</span>); |
| |
| <span class="comment">// The value sent on the permit is received |
| </span><span class="macro">assert_eq!</span>(rx.recv().<span class="kw">await</span>.unwrap(), <span class="number">456</span>); |
| |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.same_channel" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1002-1004">source</a><h4 class="code-header">pub fn <a href="#method.same_channel" class="fnname">same_channel</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if senders belong to the same channel.</p> |
| <h5 id="examples-9"><a href="#examples-9">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>(tx, rx) = tokio::sync::mpsc::channel::<()>(<span class="number">1</span>); |
| <span class="kw">let </span>tx2 = tx.clone(); |
| <span class="macro">assert!</span>(tx.same_channel(<span class="kw-2">&</span>tx2)); |
| |
| <span class="kw">let </span>(tx3, rx3) = tokio::sync::mpsc::channel::<()>(<span class="number">1</span>); |
| <span class="macro">assert!</span>(!tx3.same_channel(<span class="kw-2">&</span>tx2));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.capacity" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1039-1041">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fnname">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/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 sending a value by calling <a href="struct.Sender.html#method.send"><code>send</code></a> or by reserving capacity |
| with <a href="struct.Sender.html#method.reserve"><code>reserve</code></a>. The capacity goes up when values are received by the <a href="struct.Receiver.html" title="Receiver"><code>Receiver</code></a>. |
| This is distinct from <a href="struct.Sender.html#method.max_capacity"><code>max_capacity</code></a>, which always returns buffer capacity initially |
| specified when calling <a href="fn.channel.html"><code>channel</code></a></p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <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) = mpsc::channel::<()>(<span class="number">5</span>); |
| |
| <span class="macro">assert_eq!</span>(tx.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>(tx.capacity(), <span class="number">4</span>); |
| |
| <span class="comment">// Sending and receiving a value increases the capacity by one. |
| </span>permit.send(()); |
| rx.recv().<span class="kw">await</span>.unwrap(); |
| <span class="macro">assert_eq!</span>(tx.capacity(), <span class="number">5</span>); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.downgrade" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1047-1051">source</a><h4 class="code-header">pub fn <a href="#method.downgrade" class="fnname">downgrade</a>(&self) -> <a class="struct" href="struct.WeakSender.html" title="struct tokio::sync::mpsc::WeakSender">WeakSender</a><T></h4></section></summary><div class="docblock"><p>Converts the <code>Sender</code> to a <a href="struct.WeakSender.html" title="WeakSender"><code>WeakSender</code></a> that does not count |
| towards RAII semantics, i.e. if all <code>Sender</code> instances of the |
| channel were dropped and only <code>WeakSender</code> instances remain, |
| the channel is closed.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_capacity" class="method has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1085-1087">source</a><h4 class="code-header">pub fn <a href="#method.max_capacity" class="fnname">max_capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/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"><code>channel</code></a>. This is distinct from <a href="struct.Sender.html#method.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.Sender.html#method.capacity"><code>capacity</code></a> will go up or down, whereas the value |
| returned by <code>max_capacity</code> will remain constant.</p> |
| <h5 id="examples-11"><a href="#examples-11">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::sync::mpsc; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <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>(tx.max_capacity(), <span class="number">5</span>); |
| <span class="macro">assert_eq!</span>(tx.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>(tx.max_capacity(), <span class="number">5</span>); |
| <span class="comment">// but drops the capacity by one |
| </span><span class="macro">assert_eq!</span>(tx.capacity(), <span class="number">4</span>); |
| }</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-Clone-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1090-1096">source</a><a href="#impl-Clone-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1091-1095">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/clone.rs.html#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/tokio/sync/mpsc/bounded.rs.html#1098-1104">source</a><a href="#impl-Debug-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</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/mpsc/bounded.rs.html#1099-1103">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></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-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T></h3></section><section id="impl-Send-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section><section id="impl-Sync-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section><section id="impl-Unpin-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</a><T></h3></section><section id="impl-UnwindSafe-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Sender.html" title="struct tokio::sync::mpsc::Sender">Sender</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-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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 class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" 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-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></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="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" 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><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></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 href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/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="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/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><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> |
