Auto Generated Documentation
This commit is contained in:
github-actions[bot]
@@ -2,7 +2,7 @@
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../tokio_util/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Struct PollSender</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Methods</a><div class="sidebar-links"><a href="#method.abort_send">abort_send</a><a href="#method.clone_inner">clone_inner</a><a href="#method.close_this_sender">close_this_sender</a><a href="#method.inner_ref">inner_ref</a><a href="#method.is_closed">is_closed</a><a href="#method.is_ready">is_ready</a><a href="#method.new">new</a><a href="#method.poll_send_done">poll_send_done</a><a href="#method.start_send">start_send</a></div><a class="sidebar-title" href="#trait-implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Sink%3CT%3E">Sink<T></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class="location"><a href="../index.html">tokio_util</a>::<wbr><a href="index.html">sync</a></p><script>window.sidebarCurrent = {name: "PollSender", ty: "struct", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#18-23" title="goto source code">[src]</a></span><span class="in-band">Struct <a href="../index.html">tokio_util</a>::<wbr><a href="index.html">sync</a>::<wbr><a class="struct" href="">PollSender</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust struct">pub struct PollSender<T> { /* fields omitted */ }</pre></div><div class="docblock"><p>A wrapper around <a href="../../tokio/sync/mpsc/bounded/struct.Sender.html"><code>mpsc::Sender</code></a> that can be polled.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static> <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#37-171" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(sender: <a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>) -> Self</code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#39-45" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new <code>PollSender</code>.</p>
|
||||
</div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><h3 id="impl" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static> <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#37-168" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.new" class="method"><code>pub fn <a href="#method.new" class="fnname">new</a>(sender: <a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>) -> Self</code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#39-45" title="goto source code">[src]</a></h4><div class="docblock"><p>Create a new <code>PollSender</code>.</p>
|
||||
</div><h4 id="method.start_send" class="method"><code>pub fn <a href="#method.start_send" class="fnname">start_send</a>(&mut 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="../../tokio/sync/mpsc/error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><T>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#57-69" title="goto source code">[src]</a></h4><div class="docblock"><p>Start sending a new item.</p>
|
||||
<p>This method panics if a send is currently in progress. To ensure that no
|
||||
send is in progress, call <code>poll_send_done</code> first until it returns
|
||||
@@ -34,30 +34,30 @@ not panic.</p>
|
||||
panic.</p>
|
||||
<p>If the channel is closed, this method returns <code>true</code>.</p>
|
||||
</div><h4 id="method.is_closed" class="method"><code>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></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#117-122" title="goto source code">[src]</a></h4><div class="docblock"><p>Check whether the channel has been closed.</p>
|
||||
</div><h4 id="method.clone_inner" class="method"><code>pub fn <a href="#method.clone_inner" class="fnname">clone_inner</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#128-133" title="goto source code">[src]</a></h4><div class="docblock"><p>Clone the underlying <code>Sender</code>.</p>
|
||||
</div><h4 id="method.clone_inner" class="method"><code>pub fn <a href="#method.clone_inner" class="fnname">clone_inner</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#128-130" title="goto source code">[src]</a></h4><div class="docblock"><p>Clone the underlying <code>Sender</code>.</p>
|
||||
<p>If this method returns <code>None</code>, then the channel is closed. (But it is
|
||||
not guaranteed to return <code>None</code> if the channel is closed.)</p>
|
||||
</div><h4 id="method.inner_ref" class="method"><code>pub fn <a href="#method.inner_ref" class="fnname">inner_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#139-141" title="goto source code">[src]</a></h4><div class="docblock"><p>Access the underlying <code>Sender</code>.</p>
|
||||
</div><h4 id="method.inner_ref" class="method"><code>pub fn <a href="#method.inner_ref" class="fnname">inner_ref</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../../tokio/sync/mpsc/bounded/struct.Sender.html" title="struct tokio::sync::mpsc::bounded::Sender">Sender</a><T>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#136-138" title="goto source code">[src]</a></h4><div class="docblock"><p>Access the underlying <code>Sender</code>.</p>
|
||||
<p>If this method returns <code>None</code>, then the channel is closed. (But it is
|
||||
not guaranteed to return <code>None</code> if the channel is closed.)</p>
|
||||
</div><h4 id="method.close_this_sender" class="method"><code>pub fn <a href="#method.close_this_sender" class="fnname">close_this_sender</a>(&mut self)</code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#155-157" title="goto source code">[src]</a></h4><div class="docblock"><p>Close this sender. No more messages can be sent from this sender.</p>
|
||||
</div><h4 id="method.close_this_sender" class="method"><code>pub fn <a href="#method.close_this_sender" class="fnname">close_this_sender</a>(&mut self)</code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#152-154" title="goto source code">[src]</a></h4><div class="docblock"><p>Close this sender. No more messages can be sent from this sender.</p>
|
||||
<p>Note that this only closes the channel from the view-point of this
|
||||
sender. The channel remains open until all senders have gone away, or
|
||||
until the <a href="../../tokio/sync/mpsc/bounded/struct.Receiver.html"><code>Receiver</code></a> closes the channel.</p>
|
||||
<p>If there is a send in progress when this method is called, that send is
|
||||
unaffected by this operation, and <code>poll_send_done</code> can still be called
|
||||
to complete that send.</p>
|
||||
</div><h4 id="method.abort_send" class="method"><code>pub fn <a href="#method.abort_send" class="fnname">abort_send</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#162-170" title="goto source code">[src]</a></h4><div class="docblock"><p>Abort the current in-progress send, if any.</p>
|
||||
</div><h4 id="method.abort_send" class="method"><code>pub fn <a href="#method.abort_send" class="fnname">abort_send</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#159-167" title="goto source code">[src]</a></h4><div class="docblock"><p>Abort the current in-progress send, if any.</p>
|
||||
<p>Returns <code>true</code> if a send was aborted.</p>
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">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="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#173-183" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#176-182" title="goto source code">[src]</a></h4><div class="docblock"><p>Clones this <code>PollSender</code>. The resulting clone will not have any
|
||||
</div></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><h3 id="impl-Clone" class="impl"><code class="in-band">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="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#170-180" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.clone" class="method"><code>fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#173-179" title="goto source code">[src]</a></h4><div class="docblock"><p>Clones this <code>PollSender</code>. The resulting clone will not have any
|
||||
in-progress send operations, even if the current <code>PollSender</code> does.</p>
|
||||
</div><h4 id="method.clone_from" class="method hidden"><code>pub 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)</code><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#128-130" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
</div></div><h3 id="impl-Debug" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#17" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="method.fmt" class="method hidden"><code>fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &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></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#17" title="goto source code">[src]</a></h4><div class='docblock hidden'><p>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></p>
|
||||
</div></div><h3 id="impl-Sink%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static> <a class="trait" href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink">Sink</a><T> for <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl-Sink%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#185-224" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="../../futures_sink/trait.Sink.html#associatedtype.Error" class="type">Error</a> = <a class="struct" href="../../tokio/sync/mpsc/error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><T></code></h4><div class='docblock'><p>The type of value produced by the sink when an error occurs.</p>
|
||||
</div><h4 id="method.poll_ready" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_ready" class="fnname">poll_ready</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#191-193" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.poll_send_done"><code>poll_send_done</code></a>.</p>
|
||||
</div><h4 id="method.poll_flush" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_flush" class="fnname">poll_flush</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#198-200" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.poll_send_done"><code>poll_send_done</code></a>.</p>
|
||||
</div><h4 id="method.start_send-1" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.start_send" class="fnname">start_send</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, item: 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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#205-207" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.start_send"><code>start_send</code></a>.</p>
|
||||
</div><h4 id="method.poll_close" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_close" class="fnname">poll_close</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#218-223" title="goto source code">[src]</a></h4><div class="docblock"><p>This method will first flush the <code>PollSender</code>, and then close it by
|
||||
</div></div><h3 id="impl-Sink%3CT%3E" class="impl"><code class="in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static> <a class="trait" href="../../futures_sink/trait.Sink.html" title="trait futures_sink::Sink">Sink</a><T> for <a class="struct" href="../../tokio_util/sync/struct.PollSender.html" title="struct tokio_util::sync::PollSender">PollSender</a><T></code><a href="#impl-Sink%3CT%3E" class="anchor"></a><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#182-221" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Error" class="type"><code>type <a href="../../futures_sink/trait.Sink.html#associatedtype.Error" class="type">Error</a> = <a class="struct" href="../../tokio/sync/mpsc/error/struct.SendError.html" title="struct tokio::sync::mpsc::error::SendError">SendError</a><T></code></h4><div class='docblock'><p>The type of value produced by the sink when an error occurs.</p>
|
||||
</div><h4 id="method.poll_ready" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_ready" class="fnname">poll_ready</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#188-190" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.poll_send_done"><code>poll_send_done</code></a>.</p>
|
||||
</div><h4 id="method.poll_flush" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_flush" class="fnname">poll_flush</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#195-197" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.poll_send_done"><code>poll_send_done</code></a>.</p>
|
||||
</div><h4 id="method.start_send-1" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.start_send" class="fnname">start_send</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, item: 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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#202-204" title="goto source code">[src]</a></h4><div class="docblock"><p>This is equivalent to calling <a href="../../tokio_util/sync/struct.PollSender.html#method.start_send"><code>start_send</code></a>.</p>
|
||||
</div><h4 id="method.poll_close" class="method"><code>fn <a href="../../futures_sink/trait.Sink.html#tymethod.poll_close" class="fnname">poll_close</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, <br> cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<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>, Self::<a class="type" href="../../futures_sink/trait.Sink.html#associatedtype.Error" title="type futures_sink::Sink::Error">Error</a>>></code><a class="srclink" href="../../src/tokio_util/sync/mpsc.rs.html#215-220" title="goto source code">[src]</a></h4><div class="docblock"><p>This method will first flush the <code>PollSender</code>, and then close it by
|
||||
calling <a href="../../tokio_util/sync/struct.PollSender.html#method.close_this_sender"><code>close_this_sender</code></a>.</p>
|
||||
<p>If a send fails while flushing because the <a href="../../tokio/sync/mpsc/bounded/struct.Receiver.html"><code>Receiver</code></a> has gone away,
|
||||
then this function returns an error. The channel is still successfully
|
||||
|
||||
Reference in New Issue
Block a user