blob: ae4b88e9995add91cdc04df2a194b21c5803d399 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="The transmission end of a bounded mpsc channel."><meta name="keywords" content="rust, rustlang, rust-lang, Sender"><title>Sender in futures::channel::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">&#9776;</button><a class="sidebar-logo" href="../../../futures/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="../../../futures/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.close_channel">close_channel</a></li><li><a href="#method.disconnect">disconnect</a></li><li><a href="#method.hash_receiver">hash_receiver</a></li><li><a href="#method.is_closed">is_closed</a></li><li><a href="#method.is_connected_to">is_connected_to</a></li><li><a href="#method.poll_ready">poll_ready</a></li><li><a href="#method.same_receiver">same_receiver</a></li><li><a href="#method.start_send">start_send</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><li><a href="#impl-Sink%3CT%3E-for-Sender%3CT%3E">Sink&lt;T&gt;</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&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-Sender%3CT%3E">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E">Into&lt;U&gt;</a></li><li><a href="#impl-SinkExt%3CItem%3E-for-Sender%3CT%3E">SinkExt&lt;Item&gt;</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&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In futures::channel::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">futures</a>::<wbr><a href="../index.html">channel</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/futures_channel/mpsc/mod.rs.html#123">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Sender&lt;T&gt;(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The transmission end of a bounded mpsc channel.</p>
<p>This value is created by the <a href="fn.channel.html"><code>channel</code></a> function.</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/futures_channel/mpsc/mod.rs.html#684">source</a><a href="#impl-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_send" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#687">source</a><h4 class="code-header">pub fn <a href="#method.try_send" class="fnname">try_send</a>(&amp;mut self, msg: T) -&gt; Result&lt;(), <a class="struct" href="struct.TrySendError.html" title="struct futures::channel::mpsc::TrySendError">TrySendError</a>&lt;T&gt;&gt;</h4></section></summary><div class="docblock"><p>Attempts to send a message on this <code>Sender</code>, returning the message
if there was an error.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_send" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#700">source</a><h4 class="code-header">pub fn <a href="#method.start_send" class="fnname">start_send</a>(&amp;mut self, msg: T) -&gt; Result&lt;(), <a class="struct" href="struct.SendError.html" title="struct futures::channel::mpsc::SendError">SendError</a>&gt;</h4></section></summary><div class="docblock"><p>Send a message on the channel.</p>
<p>This function should only be called after
<a href="struct.Sender.html#method.poll_ready"><code>poll_ready</code></a> has reported that the channel is
ready to receive a message.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_ready" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#716">source</a><h4 class="code-header">pub fn <a href="#method.poll_ready" class="fnname">poll_ready</a>(&amp;mut self, cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), <a class="struct" href="struct.SendError.html" title="struct futures::channel::mpsc::SendError">SendError</a>&gt;&gt;</h4></section></summary><div class="docblock"><p>Polls the channel to determine if there is guaranteed capacity to send
at least one item without waiting.</p>
<h5 id="return-value"><a href="#return-value">Return value</a></h5>
<p>This method returns:</p>
<ul>
<li><code>Poll::Ready(Ok(_))</code> if there is sufficient capacity;</li>
<li><code>Poll::Pending</code> if the channel may not have
capacity, in which case the current task is queued to be notified once
capacity is available;</li>
<li><code>Poll::Ready(Err(SendError))</code> if the receiver has been dropped.</li>
</ul>
</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/futures_channel/mpsc/mod.rs.html#722">source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fnname">is_closed</a>(&amp;self) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns whether this channel is closed without needing a context.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.close_channel" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#727">source</a><h4 class="code-header">pub fn <a href="#method.close_channel" class="fnname">close_channel</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Closes this channel from the sender side, preventing any new messages.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.disconnect" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#734">source</a><h4 class="code-header">pub fn <a href="#method.disconnect" class="fnname">disconnect</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Disconnects this sender from the channel, closing it if there are no more senders left.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.same_receiver" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#739">source</a><h4 class="code-header">pub fn <a href="#method.same_receiver" class="fnname">same_receiver</a>(&amp;self, other: &amp;<a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns whether the senders send to the same receiver.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_connected_to" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#747">source</a><h4 class="code-header">pub fn <a href="#method.is_connected_to" class="fnname">is_connected_to</a>(&amp;self, receiver: &amp;<a class="struct" href="struct.Receiver.html" title="struct futures::channel::mpsc::Receiver">Receiver</a>&lt;T&gt;) -&gt; bool</h4></section></summary><div class="docblock"><p>Returns whether the sender send to this receiver.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_receiver" class="method has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#755-757">source</a><h4 class="code-header">pub fn <a href="#method.hash_receiver" class="fnname">hash_receiver</a>&lt;H&gt;(&amp;self, hasher: &amp;mut H)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: Hasher,</span></h4></section></summary><div class="docblock"><p>Hashes the receiver into the provided hasher</p>
</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/futures_channel/mpsc/mod.rs.html#847">source</a><a href="#impl-Clone-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Clone for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</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/futures_channel/mpsc/mod.rs.html#848">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a>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="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>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/futures_channel/mpsc/mod.rs.html#941">source</a><a href="#impl-Debug-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Debug for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/mod.rs.html#942">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result&lt;(), Error&gt;</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-Sink%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/sink_impl.rs.html#6">source</a><a href="#impl-Sink%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;T&gt; for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</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="../../sink/trait.Sink.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.SendError.html" title="struct futures::channel::mpsc::SendError">SendError</a></h4></section></summary><div class='docblock'>The type of value produced by the sink when an error occurs.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_ready-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/sink_impl.rs.html#9">source</a><a href="#method.poll_ready-1" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.Sink.html#tymethod.poll_ready" class="fnname">poll_ready</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), &lt;<a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt; as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;T&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;</h4></section></summary><div class='docblock'>Attempts to prepare the <code>Sink</code> to receive a value. <a href="../../sink/trait.Sink.html#tymethod.poll_ready">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_send-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/sink_impl.rs.html#13">source</a><a href="#method.start_send-1" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.Sink.html#tymethod.start_send" class="fnname">start_send</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;msg: T<br>) -&gt; Result&lt;(), &lt;<a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt; as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;T&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
<code>poll_ready</code> which returned <code>Poll::Ready(Ok(()))</code>. <a href="../../sink/trait.Sink.html#tymethod.start_send">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_flush" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/sink_impl.rs.html#17">source</a><a href="#method.poll_flush" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.Sink.html#tymethod.poll_flush" class="fnname">poll_flush</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), &lt;<a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt; as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;T&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;</h4></section></summary><div class='docblock'>Flush any remaining output from this sink. <a href="../../sink/trait.Sink.html#tymethod.poll_flush">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_close" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_channel/mpsc/sink_impl.rs.html#27">source</a><a href="#method.poll_close" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.Sink.html#tymethod.poll_close" class="fnname">poll_close</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;self: Pin&lt;&amp;mut <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), &lt;<a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt; as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;T&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;</h4></section></summary><div class='docblock'>Flush any remaining output and close this sink, if necessary. <a href="../../sink/trait.Sink.html#tymethod.poll_close">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&lt;T&gt; !RefUnwindSafe for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</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&lt;T&gt; Send for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Send,</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&lt;T&gt; Sync for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Send,</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&lt;T&gt; Unpin for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</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&lt;T&gt; !UnwindSafe for <a class="struct" href="struct.Sender.html" title="struct futures::channel::mpsc::Sender">Sender</a>&lt;T&gt;</h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SinkExt%3CItem%3E-for-Sender%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#61">source</a><a href="#impl-SinkExt%3CItem%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, Item&gt; <a class="trait" href="../../sink/trait.SinkExt.html" title="trait futures::sink::SinkExt">SinkExt</a>&lt;Item&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt; + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#77-82">source</a><a href="#method.with" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.with" class="fnname">with</a>&lt;U, Fut, F, E&gt;(self, f: F) -&gt; <a class="struct" href="../../sink/struct.With.html" title="struct futures::sink::With">With</a>&lt;Self, Item, U, Fut, F&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: FnMut(U) -&gt; Fut,<br>&nbsp;&nbsp;&nbsp;&nbsp;Fut: <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Output = Result&lt;Item, E&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;E: From&lt;Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;,</span></h4></section></summary><div class='docblock'>Composes a function <em>in front of</em> the sink. <a href="../../sink/trait.SinkExt.html#method.with">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_flat_map" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#119-123">source</a><a href="#method.with_flat_map" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.with_flat_map" class="fnname">with_flat_map</a>&lt;U, St, F&gt;(self, f: F) -&gt; <a class="struct" href="../../sink/struct.WithFlatMap.html" title="struct futures::sink::WithFlatMap">WithFlatMap</a>&lt;Self, Item, U, St, F&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: FnMut(U) -&gt; St,<br>&nbsp;&nbsp;&nbsp;&nbsp;St: <a class="trait" href="../../stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&lt;Item = Result&lt;Item, Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;,</span></h4></section></summary><div class='docblock'>Composes a function <em>in front of</em> the sink. <a href="../../sink/trait.SinkExt.html#method.with_flat_map">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sink_map_err" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#143-146">source</a><a href="#method.sink_map_err" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.sink_map_err" class="fnname">sink_map_err</a>&lt;E, F&gt;(self, f: F) -&gt; <a class="struct" href="../../sink/struct.SinkMapErr.html" title="struct futures::sink::SinkMapErr">SinkMapErr</a>&lt;Self, F&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;F: FnOnce(Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>) -&gt; E,</span></h4></section></summary><div class='docblock'>Transforms the error returned by the sink.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sink_err_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#154-157">source</a><a href="#method.sink_err_into" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.sink_err_into" class="fnname">sink_err_into</a>&lt;E&gt;(self) -&gt; <a class="struct" href="../../sink/struct.SinkErrInto.html" title="struct futures::sink::SinkErrInto">SinkErrInto</a>&lt;Self, Item, E&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>: Into&lt;E&gt;,</span></h4></section></summary><div class='docblock'>Map this sink’s error to a different error type using the <code>Into</code> trait. <a href="../../sink/trait.SinkExt.html#method.sink_err_into">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.buffer" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#175-177">source</a><a href="#method.buffer" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.buffer" class="fnname">buffer</a>(self, capacity: usize) -&gt; <a class="struct" href="../../sink/struct.Buffer.html" title="struct futures::sink::Buffer">Buffer</a>&lt;Self, Item&gt;</h4></section></summary><div class='docblock'>Adds a fixed-size buffer to the current sink. <a href="../../sink/trait.SinkExt.html#method.buffer">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.close" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#183-185">source</a><a href="#method.close" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.close" class="fnname">close</a>(&amp;mut self) -&gt; <a class="struct" href="../../sink/struct.Close.html" title="struct futures::sink::Close">Close</a>&lt;'_, Self, Item&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../../sink/struct.Close.html" title="struct futures::sink::Close">Close</a>&lt;'_, Si, Item&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;Si, Item&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../sink/struct.Close.html" title="struct futures::sink::Close">Close</a>&lt;'_, Si, Item&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt; + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result&lt;(), &lt;Si as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>Close the sink.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fanout" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#194-198">source</a><a href="#method.fanout" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.fanout" class="fnname">fanout</a>&lt;Si&gt;(self, other: Si) -&gt; <a class="struct" href="../../sink/struct.Fanout.html" title="struct futures::sink::Fanout">Fanout</a>&lt;Self, Si&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Item: Clone,<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item, Error = Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;,</span></h4></section></summary><div class='docblock'>Fanout items to multiple sinks. <a href="../../sink/trait.SinkExt.html#method.fanout">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.flush" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#207-209">source</a><a href="#method.flush" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.flush" class="fnname">flush</a>(&amp;mut self) -&gt; <a class="struct" href="../../sink/struct.Flush.html" title="struct futures::sink::Flush">Flush</a>&lt;'_, Self, Item&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../../sink/struct.Flush.html" title="struct futures::sink::Flush">Flush</a>&lt;'_, Si, Item&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;Si, Item&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../sink/struct.Flush.html" title="struct futures::sink::Flush">Flush</a>&lt;'_, Si, Item&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt; + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result&lt;(), &lt;Si as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>Flush the sink, processing all pending items. <a href="../../sink/trait.SinkExt.html#method.flush">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#220-222">source</a><a href="#method.send" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.send" class="fnname">send</a>(&amp;mut self, item: Item) -&gt; <a class="struct" href="../../sink/struct.Send.html" title="struct futures::sink::Send">Send</a>&lt;'_, Self, Item&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../../sink/struct.Send.html" title="struct futures::sink::Send">Send</a>&lt;'_, Si, Item&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;Si, Item&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../sink/struct.Send.html" title="struct futures::sink::Send">Send</a>&lt;'_, Si, Item&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt; + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result&lt;(), &lt;Si as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A future that completes after the given item has been fully processed
into the sink, including flushing. <a href="../../sink/trait.SinkExt.html#method.send">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.feed" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#233-235">source</a><a href="#method.feed" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.feed" class="fnname">feed</a>(&amp;mut self, item: Item) -&gt; <a class="struct" href="../../sink/struct.Feed.html" title="struct futures::sink::Feed">Feed</a>&lt;'_, Self, Item&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../../sink/struct.Feed.html" title="struct futures::sink::Feed">Feed</a>&lt;'_, Si, Item&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;Si, Item&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../sink/struct.Feed.html" title="struct futures::sink::Feed">Feed</a>&lt;'_, Si, Item&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt; + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result&lt;(), &lt;Si as <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item&gt;&gt;::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A future that completes after the given item has been received
by the sink. <a href="../../sink/trait.SinkExt.html#method.feed">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_all" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#252-256">source</a><a href="#method.send_all" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.send_all" class="fnname">send_all</a>&lt;St&gt;(&amp;'a mut self, stream: &amp;'a mut St) -&gt; <a class="struct" href="../../sink/struct.SendAll.html" title="struct futures::sink::SendAll">SendAll</a>&lt;'a, Self, St&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="struct" href="../../sink/struct.SendAll.html" title="struct futures::sink::SendAll">SendAll</a>&lt;'_, Si, St&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;Si, St, Ok, Error&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="struct" href="../../sink/struct.SendAll.html" title="struct futures::sink::SendAll">SendAll</a>&lt;'_, Si, St&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Ok, Error = Error&gt; + Unpin + ?Sized,<br>&nbsp;&nbsp;&nbsp;&nbsp;St: <a class="trait" href="../../stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>&lt;Item = Result&lt;Ok, Error&gt;&gt; + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = Result&lt;(), Error&gt;;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;St: <a class="trait" href="../../stream/trait.TryStream.html" title="trait futures::stream::TryStream">TryStream</a>&lt;Ok = Item, Error = Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt; + <a class="trait" href="../../stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> + Unpin + ?Sized,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A future that completes after the given stream has been fully processed
into the sink, including flushing. <a href="../../sink/trait.SinkExt.html#method.send_all">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.left_sink" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#268-271">source</a><a href="#method.left_sink" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.left_sink" class="fnname">left_sink</a>&lt;Si2&gt;(self) -&gt; <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;Self, Si2&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;A, B&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;A, B&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;A, B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Output = &lt;A as <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&gt;::<a class="associatedtype" href="../../future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>&gt;,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = &lt;A as <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&gt;::<a class="associatedtype" href="../../future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si2: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item, Error = Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;,</span></h4></section></summary><div class='docblock'>Wrap this sink in an <code>Either</code> sink, making it the left-hand variant
of that <code>Either</code>. <a href="../../sink/trait.SinkExt.html#method.left_sink">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.right_sink" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#281-284">source</a><a href="#method.right_sink" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.right_sink" class="fnname">right_sink</a>&lt;Si1&gt;(self) -&gt; <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;Si1, Self&gt;<span class="notable-traits"><span class="notable-traits-tooltip"><span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;A, B&gt;</span><code class="content"><span class="where fmt-newline">impl&lt;A, B&gt; <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a> for <a class="enum" href="../../future/enum.Either.html" title="enum futures::future::Either">Either</a>&lt;A, B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Output = &lt;A as <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&gt;::<a class="associatedtype" href="../../future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>&gt;,</span></span><span class="where fmt-newline"> type <a href="../../future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</a> = &lt;A as <a class="trait" href="../../future/trait.Future.html" title="trait futures::future::Future">Future</a>&gt;::<a class="associatedtype" href="../../future/trait.Future.html#associatedtype.Output" title="type futures::future::Future::Output">Output</a>;</span></code></span></span></span></span><span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Si1: <a class="trait" href="../../sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>&lt;Item, Error = Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;,</span></h4></section></summary><div class='docblock'>Wrap this stream in an <code>Either</code> stream, making it the right-hand variant
of that <code>Either</code>. <a href="../../sink/trait.SinkExt.html#method.right_sink">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_ready_unpin" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#302-304">source</a><a href="#method.poll_ready_unpin" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.poll_ready_unpin" class="fnname">poll_ready_unpin</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A convenience method for calling <a href="../../sink/trait.Sink.html#tymethod.poll_ready" title="Sink::poll_ready"><code>Sink::poll_ready</code></a> on [<code>Unpin</code>]
sink types. <a href="../../sink/trait.SinkExt.html#method.poll_ready_unpin">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_send_unpin" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#311-313">source</a><a href="#method.start_send_unpin" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.start_send_unpin" class="fnname">start_send_unpin</a>(&amp;mut self, item: Item) -&gt; Result&lt;(), Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A convenience method for calling <a href="../../sink/trait.Sink.html#tymethod.start_send" title="Sink::start_send"><code>Sink::start_send</code></a> on [<code>Unpin</code>]
sink types. <a href="../../sink/trait.SinkExt.html#method.start_send_unpin">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_flush_unpin" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#320-322">source</a><a href="#method.poll_flush_unpin" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.poll_flush_unpin" class="fnname">poll_flush_unpin</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A convenience method for calling <a href="../../sink/trait.Sink.html#tymethod.poll_flush" title="Sink::poll_flush"><code>Sink::poll_flush</code></a> on [<code>Unpin</code>]
sink types. <a href="../../sink/trait.SinkExt.html#method.poll_flush_unpin">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_close_unpin" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/futures_util/sink/mod.rs.html#329-331">source</a><a href="#method.poll_close_unpin" class="anchor"></a><h4 class="code-header">fn <a href="../../sink/trait.SinkExt.html#method.poll_close_unpin" class="fnname">poll_close_unpin</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self,<br>&nbsp;&nbsp;&nbsp;&nbsp;cx: &amp;mut <a class="struct" href="../../task/struct.Context.html" title="struct futures::task::Context">Context</a>&lt;'_&gt;<br>) -&gt; <a class="enum" href="../../task/enum.Poll.html" title="enum futures::task::Poll">Poll</a>&lt;Result&lt;(), Self::<a class="associatedtype" href="../../sink/trait.Sink.html#associatedtype.Error" title="type futures::sink::Sink::Error">Error</a>&gt;&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: Unpin,</span></h4></section></summary><div class='docblock'>A convenience method for calling <a href="../../sink/trait.Sink.html#tymethod.poll_close" title="Sink::poll_close"><code>Sink::poll_close</code></a> on [<code>Unpin</code>]
sink types. <a href="../../sink/trait.SinkExt.html#method.poll_close_unpin">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</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 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 href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>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 href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>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 href="#impl-TryFrom%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Sender%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Sender%3CT%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-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> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>