| <!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="An extension trait for `Sink`s that provides a variety of convenient combinator functions."><meta name="keywords" content="rust, rustlang, rust-lang, SinkExt"><title>SinkExt in futures_util::sink - 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 trait"><!--[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="../../futures_util/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_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SinkExt</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.buffer">buffer</a></li><li><a href="#method.close">close</a></li><li><a href="#method.fanout">fanout</a></li><li><a href="#method.feed">feed</a></li><li><a href="#method.flush">flush</a></li><li><a href="#method.left_sink">left_sink</a></li><li><a href="#method.poll_close_unpin">poll_close_unpin</a></li><li><a href="#method.poll_flush_unpin">poll_flush_unpin</a></li><li><a href="#method.poll_ready_unpin">poll_ready_unpin</a></li><li><a href="#method.right_sink">right_sink</a></li><li><a href="#method.send">send</a></li><li><a href="#method.send_all">send_all</a></li><li><a href="#method.sink_err_into">sink_err_into</a></li><li><a href="#method.sink_map_err">sink_map_err</a></li><li><a href="#method.start_send_unpin">start_send_unpin</a></li><li><a href="#method.with">with</a></li><li><a href="#method.with_flat_map">with_flat_map</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In futures_util::sink</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">Trait <a href="../index.html">futures_util</a>::<wbr><a href="index.html">sink</a>::<wbr><a class="trait" href="#">SinkExt</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_util/sink/mod.rs.html#65-335">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 trait"><code>pub trait SinkExt<Item>: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> { |
| <details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 17 methods</span></summary> fn <a href="#method.with" class="fnname">with</a><U, Fut, F, E>(self, f: F) -> <a class="struct" href="struct.With.html" title="struct futures_util::sink::With">With</a><Self, Item, U, Fut, F><br> <span class="where">where<br> F: FnMut(U) -> Fut,<br> Fut: Future<Output = Result<Item, E>>,<br> E: From<Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.with_flat_map" class="fnname">with_flat_map</a><U, St, F>(self, f: F) -> <a class="struct" href="struct.WithFlatMap.html" title="struct futures_util::sink::WithFlatMap">WithFlatMap</a><Self, Item, U, St, F><br> <span class="where">where<br> F: FnMut(U) -> St,<br> St: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<Item, Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>>,<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.sink_map_err" class="fnname">sink_map_err</a><E, F>(self, f: F) -> <a class="struct" href="struct.SinkMapErr.html" title="struct futures_util::sink::SinkMapErr">SinkMapErr</a><Self, F><br> <span class="where">where<br> F: FnOnce(Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>) -> E,<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.sink_err_into" class="fnname">sink_err_into</a><E>(self) -> <a class="struct" href="struct.SinkErrInto.html" title="struct futures_util::sink::SinkErrInto">SinkErrInto</a><Self, Item, E><br> <span class="where">where<br> Self: Sized,<br> Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>: Into<E></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.buffer" class="fnname">buffer</a>(self, capacity: usize) -> <a class="struct" href="struct.Buffer.html" title="struct futures_util::sink::Buffer">Buffer</a><Self, Item><br> <span class="where">where<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.close" class="fnname">close</a>(&mut self) -> <a class="struct" href="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Self, Item><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="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.fanout" class="fnname">fanout</a><Si>(self, other: Si) -> <a class="struct" href="struct.Fanout.html" title="struct futures_util::sink::Fanout">Fanout</a><Self, Si><br> <span class="where">where<br> Self: Sized,<br> Item: Clone,<br> Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>></span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.flush" class="fnname">flush</a>(&mut self) -> <a class="struct" href="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Self, Item><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="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.send" class="fnname">send</a>(&mut self, item: Item) -> <a class="struct" href="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Self, Item><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="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.feed" class="fnname">feed</a>(&mut self, item: Item) -> <a class="struct" href="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Self, Item><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="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.send_all" class="fnname">send_all</a><'a, St>(<br> &'a mut self,<br> stream: &'a mut St<br> ) -> <a class="struct" href="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'a, Self, St><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="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'_, Si, St></span><code class="content"><span class="where fmt-newline">impl<Si, St, Ok, Error> Future for <a class="struct" href="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'_, Si, St><span class="where fmt-newline">where<br> Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Ok, Error = Error> + Unpin + ?Sized,<br> St: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<Ok, Error>> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Error>;</span></code></span></span></span></span><br> <span class="where">where<br> St: <a class="trait" href="../stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a><Ok = Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>> + <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + Unpin + ?Sized,<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.left_sink" class="fnname">left_sink</a><Si2>(self) -> <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><Self, Si2><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_util::future::Either">Either</a><A, B></span><code class="content"><span class="where fmt-newline">impl<A, B> Future for <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Future,<br> B: Future<Output = A::Output>,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = A::Output;</span></code></span></span></span></span><br> <span class="where">where<br> Si2: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.right_sink" class="fnname">right_sink</a><Si1>(self) -> <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><Si1, Self><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_util::future::Either">Either</a><A, B></span><code class="content"><span class="where fmt-newline">impl<A, B> Future for <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Future,<br> B: Future<Output = A::Output>,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = A::Output;</span></code></span></span></span></span><br> <span class="where">where<br> Si1: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.poll_ready_unpin" class="fnname">poll_ready_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br> ) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.start_send_unpin" class="fnname">start_send_unpin</a>(&mut self, item: Item) -> Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.poll_flush_unpin" class="fnname">poll_flush_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br> ) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| <span class="item-spacer"></span> fn <a href="#method.poll_close_unpin" class="fnname">poll_close_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br> ) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><br> <span class="where">where<br> Self: Unpin</span>, |
| { ... } |
| </details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An extension trait for <code>Sink</code>s that provides a variety of convenient |
| combinator functions.</p> |
| </div></details><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#77-85">source</a><h4 class="code-header">fn <a href="#method.with" class="fnname">with</a><U, Fut, F, E>(self, f: F) -> <a class="struct" href="struct.With.html" title="struct futures_util::sink::With">With</a><Self, Item, U, Fut, F><span class="where fmt-newline">where<br> F: FnMut(U) -> Fut,<br> Fut: Future<Output = Result<Item, E>>,<br> E: From<Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Composes a function <em>in front of</em> the sink.</p> |
| <p>This adapter produces a new sink that passes each value through the |
| given function <code>f</code> before sending it to <code>self</code>.</p> |
| <p>To process each value, <code>f</code> produces a <em>future</em>, which is then polled to |
| completion before passing its result down to the underlying sink. If the |
| future produces an error, that error is returned by the new sink.</p> |
| <p>Note that this function consumes the given sink, returning a wrapped |
| version, much like <code>Iterator::map</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_flat_map" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#119-126">source</a><h4 class="code-header">fn <a href="#method.with_flat_map" class="fnname">with_flat_map</a><U, St, F>(self, f: F) -> <a class="struct" href="struct.WithFlatMap.html" title="struct futures_util::sink::WithFlatMap">WithFlatMap</a><Self, Item, U, St, F><span class="where fmt-newline">where<br> F: FnMut(U) -> St,<br> St: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<Item, Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>>,<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Composes a function <em>in front of</em> the sink.</p> |
| <p>This adapter produces a new sink that passes each value through the |
| given function <code>f</code> before sending it to <code>self</code>.</p> |
| <p>To process each value, <code>f</code> produces a <em>stream</em>, of which each value |
| is passed to the underlying sink. A new value will not be accepted until |
| the stream has been drained</p> |
| <p>Note that this function consumes the given sink, returning a wrapped |
| version, much like <code>Iterator::flat_map</code>.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::channel::mpsc; |
| <span class="kw">use </span>futures::sink::SinkExt; |
| <span class="kw">use </span>futures::stream::{<span class="self">self</span>, StreamExt}; |
| |
| <span class="kw">let </span>(tx, rx) = mpsc::channel(<span class="number">5</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>tx = tx.with_flat_map(|x| { |
| stream::iter(<span class="macro">vec!</span>[<span class="prelude-val">Ok</span>(<span class="number">42</span>); x]) |
| }); |
| |
| tx.send(<span class="number">5</span>).<span class="kw">await</span>.unwrap(); |
| drop(tx); |
| <span class="kw">let </span>received: Vec<i32> = rx.collect().<span class="kw">await</span>; |
| <span class="macro">assert_eq!</span>(received, <span class="macro">vec!</span>[<span class="number">42</span>, <span class="number">42</span>, <span class="number">42</span>, <span class="number">42</span>, <span class="number">42</span>]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sink_map_err" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#143-149">source</a><h4 class="code-header">fn <a href="#method.sink_map_err" class="fnname">sink_map_err</a><E, F>(self, f: F) -> <a class="struct" href="struct.SinkMapErr.html" title="struct futures_util::sink::SinkMapErr">SinkMapErr</a><Self, F><span class="where fmt-newline">where<br> F: FnOnce(Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>) -> E,<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Transforms the error returned by the sink.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sink_err_into" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#154-160">source</a><h4 class="code-header">fn <a href="#method.sink_err_into" class="fnname">sink_err_into</a><E>(self) -> <a class="struct" href="struct.SinkErrInto.html" title="struct futures_util::sink::SinkErrInto">SinkErrInto</a><Self, Item, E><span class="where fmt-newline">where<br> Self: Sized,<br> Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>: Into<E>,</span></h4></section></summary><div class="docblock"><p>Map this sink’s error to a different error type using the <code>Into</code> trait.</p> |
| <p>If wanting to map errors of a <code>Sink + Stream</code>, use <code>.sink_err_into().err_into()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.buffer" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#175-180">source</a><h4 class="code-header">fn <a href="#method.buffer" class="fnname">buffer</a>(self, capacity: usize) -> <a class="struct" href="struct.Buffer.html" title="struct futures_util::sink::Buffer">Buffer</a><Self, Item><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Adds a fixed-size buffer to the current sink.</p> |
| <p>The resulting sink will buffer up to <code>capacity</code> items when the |
| underlying sink is unwilling to accept additional items. Calling <code>flush</code> |
| on the buffered sink will attempt to both empty the buffer and complete |
| processing on the underlying sink.</p> |
| <p>Note that this function consumes the given sink, returning a wrapped |
| version, much like <code>Iterator::map</code>.</p> |
| <p>This method is only available when the <code>std</code> or <code>alloc</code> feature of this |
| library is activated, and it is activated by default.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.close" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#183-188">source</a><h4 class="code-header">fn <a href="#method.close" class="fnname">close</a>(&mut self) -> <a class="struct" href="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Self, Item><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="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Close.html" title="struct futures_util::sink::Close">Close</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>Close the sink.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fanout" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#194-201">source</a><h4 class="code-header">fn <a href="#method.fanout" class="fnname">fanout</a><Si>(self, other: Si) -> <a class="struct" href="struct.Fanout.html" title="struct futures_util::sink::Fanout">Fanout</a><Self, Si><span class="where fmt-newline">where<br> Self: Sized,<br> Item: Clone,<br> Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,</span></h4></section></summary><div class="docblock"><p>Fanout items to multiple sinks.</p> |
| <p>This adapter clones each incoming item and forwards it to both this as well as |
| the other sink at the same time.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.flush" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#207-212">source</a><h4 class="code-header">fn <a href="#method.flush" class="fnname">flush</a>(&mut self) -> <a class="struct" href="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Self, Item><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="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>Flush the sink, processing all pending items.</p> |
| <p>This adapter is intended to be used when you want to stop sending to the sink |
| until all current requests are processed.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#220-225">source</a><h4 class="code-header">fn <a href="#method.send" class="fnname">send</a>(&mut self, item: Item) -> <a class="struct" href="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Self, Item><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="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Send.html" title="struct futures_util::sink::Send">Send</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A future that completes after the given item has been fully processed |
| into the sink, including flushing.</p> |
| <p>Note that, <strong>because of the flushing requirement, it is usually better |
| to batch together items to send via <code>feed</code> or <code>send_all</code>, |
| rather than flushing between each item.</strong></p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.feed" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#233-238">source</a><h4 class="code-header">fn <a href="#method.feed" class="fnname">feed</a>(&mut self, item: Item) -> <a class="struct" href="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Self, Item><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="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Si, Item></span><code class="content"><span class="where fmt-newline">impl<Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a><'_, Si, Item></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Si::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A future that completes after the given item has been received |
| by the sink.</p> |
| <p>Unlike <code>send</code>, the returned future does not flush the sink. |
| It is the caller’s responsibility to ensure all pending items |
| are processed, which can be done via <code>flush</code> or <code>close</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.send_all" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#252-261">source</a><h4 class="code-header">fn <a href="#method.send_all" class="fnname">send_all</a><'a, St>(&'a mut self, stream: &'a mut St) -> <a class="struct" href="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'a, Self, St><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="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'_, Si, St></span><code class="content"><span class="where fmt-newline">impl<Si, St, Ok, Error> Future for <a class="struct" href="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a><'_, Si, St><span class="where fmt-newline">where<br> Si: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Ok, Error = Error> + Unpin + ?Sized,<br> St: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<Ok, Error>> + Unpin + ?Sized,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<(), Error>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> St: <a class="trait" href="../stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a><Ok = Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>> + <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + Unpin + ?Sized,<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A future that completes after the given stream has been fully processed |
| into the sink, including flushing.</p> |
| <p>This future will drive the stream to keep producing items until it is |
| exhausted, sending each item to the sink. It will complete once both the |
| stream is exhausted, the sink has received all items, and the sink has |
| been flushed. Note that the sink is <strong>not</strong> closed. If the stream produces |
| an error, that error will be returned by this future without flushing the sink.</p> |
| <p>Doing <code>sink.send_all(stream)</code> is roughly equivalent to |
| <code>stream.forward(sink)</code>. The returned future will exhaust all items from |
| <code>stream</code> and send them to <code>self</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.left_sink" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#268-274">source</a><h4 class="code-header">fn <a href="#method.left_sink" class="fnname">left_sink</a><Si2>(self) -> <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><Self, Si2><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_util::future::Either">Either</a><A, B></span><code class="content"><span class="where fmt-newline">impl<A, B> Future for <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Future,<br> B: Future<Output = A::Output>,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = A::Output;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Si2: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Wrap this sink in an <code>Either</code> sink, making it the left-hand variant |
| of that <code>Either</code>.</p> |
| <p>This can be used in combination with the <code>right_sink</code> method to write <code>if</code> |
| statements that evaluate to different streams in different branches.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.right_sink" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#281-287">source</a><h4 class="code-header">fn <a href="#method.right_sink" class="fnname">right_sink</a><Si1>(self) -> <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><Si1, Self><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_util::future::Either">Either</a><A, B></span><code class="content"><span class="where fmt-newline">impl<A, B> Future for <a class="enum" href="../future/enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Future,<br> B: Future<Output = A::Output>,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = A::Output;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Si1: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</span></h4></section></summary><div class="docblock"><p>Wrap this stream in an <code>Either</code> stream, making it the right-hand variant |
| of that <code>Either</code>.</p> |
| <p>This can be used in combination with the <code>left_sink</code> method to write <code>if</code> |
| statements that evaluate to different streams in different branches.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_ready_unpin" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#302-307">source</a><h4 class="code-header">fn <a href="#method.poll_ready_unpin" class="fnname">poll_ready_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A convenience method for calling <a href="trait.Sink.html#tymethod.poll_ready" title="Sink::poll_ready"><code>Sink::poll_ready</code></a> on [<code>Unpin</code>] |
| sink types.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_send_unpin" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#311-316">source</a><h4 class="code-header">fn <a href="#method.start_send_unpin" class="fnname">start_send_unpin</a>(&mut self, item: Item) -> Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A convenience method for calling <a href="trait.Sink.html#tymethod.start_send" title="Sink::start_send"><code>Sink::start_send</code></a> on [<code>Unpin</code>] |
| sink types.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_flush_unpin" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#320-325">source</a><h4 class="code-header">fn <a href="#method.poll_flush_unpin" class="fnname">poll_flush_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A convenience method for calling <a href="trait.Sink.html#tymethod.poll_flush" title="Sink::poll_flush"><code>Sink::poll_flush</code></a> on [<code>Unpin</code>] |
| sink types.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_close_unpin" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/sink/mod.rs.html#329-334">source</a><h4 class="code-header">fn <a href="#method.poll_close_unpin" class="fnname">poll_close_unpin</a>(<br> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class="docblock"><p>A convenience method for calling <a href="trait.Sink.html#tymethod.poll_close" title="Sink::poll_close"><code>Sink::poll_close</code></a> on [<code>Unpin</code>] |
| sink types.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-SinkExt%3CItem%3E-for-T" 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-T" class="anchor"></a><h3 class="code-header">impl<T: ?Sized, Item> <a class="trait" href="trait.SinkExt.html" title="trait futures_util::sink::SinkExt">SinkExt</a><Item> for T<span class="where fmt-newline">where<br> T: <a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item>,</span></h3></section></div><script src="../../implementors/futures_util/sink/trait.SinkExt.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
