| <!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="Stream for the `take_until` method."><meta name="keywords" content="rust, rustlang, rust-lang, TakeUntil"><title>TakeUntil in futures_util::stream - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../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="#">TakeUntil</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.get_pin_mut">get_pin_mut</a></li><li><a href="#method.get_ref">get_ref</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.is_stopped">is_stopped</a></li><li><a href="#method.take_future">take_future</a></li><li><a href="#method.take_result">take_result</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-TakeUntil%3CSt%2C%20Fut%3E">Debug</a></li><li><a href="#impl-FusedStream-for-TakeUntil%3CSt%2C%20Fut%3E">FusedStream</a></li><li><a href="#impl-Sink%3CItem%3E-for-TakeUntil%3CS%2C%20Fut%3E">Sink<Item></a></li><li><a href="#impl-Stream-for-TakeUntil%3CSt%2C%20Fut%3E">Stream</a></li><li><a href="#impl-Unpin-for-TakeUntil%3CSt%2C%20Fut%3E">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-TakeUntil%3CSt%2C%20Fut%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-TakeUntil%3CSt%2C%20Fut%3E">Send</a></li><li><a href="#impl-Sync-for-TakeUntil%3CSt%2C%20Fut%3E">Sync</a></li><li><a href="#impl-UnwindSafe-for-TakeUntil%3CSt%2C%20Fut%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-TakeUntil%3CSt%2C%20Fut%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E">Into<U></a></li><li><a href="#impl-SinkExt%3CItem%3E-for-TakeUntil%3CSt%2C%20Fut%3E">SinkExt<Item></a></li><li><a href="#impl-TryFrom%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E">TryInto<U></a></li><li><a href="#impl-TryStream-for-TakeUntil%3CSt%2C%20Fut%3E">TryStream</a></li></ul></section><h2><a href="index.html">In futures_util::stream</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_util</a>::<wbr><a href="index.html">stream</a>::<wbr><a class="struct" href="#">TakeUntil</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/stream/stream/take_until.rs.html#13-28">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct TakeUntil<St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>, Fut: Future> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Stream for the <a href="trait.StreamExt.html#method.take_until"><code>take_until</code></a> method.</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-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#41-109">source</a><a href="#impl-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,<br> Fut: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#50">source</a><h4 class="code-header">pub fn <a href="#method.get_ref" class="fnname">get_ref</a>(&self) -> &St</h4></section></summary><div class="docblock"><p>Acquires a reference to the underlying sink or stream that this combinator is |
| pulling from.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#50">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> &mut St</h4></section></summary><div class="docblock"><p>Acquires a mutable reference to the underlying sink or stream that this |
| combinator is pulling from.</p> |
| <p>Note that care must be taken to avoid tampering with the state of the |
| sink or stream which may otherwise confuse this combinator.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_pin_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#50">source</a><h4 class="code-header">pub fn <a href="#method.get_pin_mut" class="fnname">get_pin_mut</a>(self: Pin<&mut Self>) -> Pin<&mut St><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for Pin<P></span><code class="content"><span class="where fmt-newline">impl<P> Future for Pin<P><span class="where fmt-newline">where<br> P: DerefMut,<br> <P as Deref>::Target: Future,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = <<P as Deref>::Target as Future>::Output;</span></code></span></span></span></span></h4></section></summary><div class="docblock"><p>Acquires a pinned mutable reference to the underlying sink or stream that this |
| combinator is pulling from.</p> |
| <p>Note that care must be taken to avoid tampering with the state of the |
| sink or stream which may otherwise confuse this combinator.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#50">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> St</h4></section></summary><div class="docblock"><p>Consumes this combinator, returning the underlying sink or stream.</p> |
| <p>Note that this may discard intermediate state of this combinator, so |
| care should be taken to avoid losing resources when this is called.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take_future" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#56-62">source</a><h4 class="code-header">pub fn <a href="#method.take_future" class="fnname">take_future</a>(&mut self) -> Option<Fut></h4></section></summary><div class="docblock"><p>Extract the stopping future out of the combinator. |
| The future is returned only if it isn’t resolved yet, ie. if the stream isn’t stopped yet. |
| Taking out the future means the combinator will be yielding |
| elements from the wrapped stream without ever stopping it.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take_result" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#100-102">source</a><h4 class="code-header">pub fn <a href="#method.take_result" class="fnname">take_result</a>(&mut self) -> Option<Fut::Output></h4></section></summary><div class="docblock"><p>Once the stopping future is resolved, this method can be used |
| to extract the value returned by the stopping future.</p> |
| <p>This may be used to retrieve arbitrary data from the stopping |
| future, for example a reason why the stream was stopped.</p> |
| <p>This method will return <code>None</code> if the future isn’t resolved yet, |
| or if the result was already taken out.</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::future; |
| <span class="kw">use </span>futures::stream::{<span class="self">self</span>, StreamExt}; |
| <span class="kw">use </span>futures::task::Poll; |
| |
| <span class="kw">let </span>stream = stream::iter(<span class="number">1</span>..=<span class="number">10</span>); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>; |
| <span class="kw">let </span>stop_fut = future::poll_fn(|_cx| { |
| i += <span class="number">1</span>; |
| <span class="kw">if </span>i <= <span class="number">5 </span>{ |
| Poll::Pending |
| } <span class="kw">else </span>{ |
| Poll::Ready(<span class="string">"reason"</span>) |
| } |
| }); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>stream = stream.take_until(stop_fut); |
| <span class="kw">let _ </span>= stream.by_ref().collect::<Vec<<span class="kw">_</span>>>().<span class="kw">await</span>; |
| |
| <span class="kw">let </span>result = stream.take_result().unwrap(); |
| <span class="macro">assert_eq!</span>(result, <span class="string">"reason"</span>);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_stopped" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#106-108">source</a><h4 class="code-header">pub fn <a href="#method.is_stopped" class="fnname">is_stopped</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Whether the stream was stopped yet by the stopping future |
| being resolved.</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-Debug-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#30-39">source</a><a href="#impl-Debug-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> Debug for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + Debug,<br> St::<a class="associatedtype" href="trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>: Debug,<br> Fut: Future + Debug,</span></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_util/stream/stream/take_until.rs.html#36-38">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FusedStream-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#150-158">source</a><a href="#impl-FusedStream-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> <a class="trait" href="trait.FusedStream.html" title="trait futures_util::stream::FusedStream">FusedStream</a> for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,<br> Fut: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_terminated" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#155-157">source</a><a href="#method.is_terminated" class="anchor"></a><h4 class="code-header">fn <a href="trait.FusedStream.html#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> bool</h4></section></summary><div class='docblock'>Returns <code>true</code> if the stream should no longer be polled.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Sink%3CItem%3E-for-TakeUntil%3CS%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#162-170">source</a><a href="#impl-Sink%3CItem%3E-for-TakeUntil%3CS%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<S, Fut, Item> <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><S, Fut><span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item>,<br> Fut: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="../sink/trait.Sink.html#associatedtype.Error" class="associatedtype">Error</a> = <S as <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item>>::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</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" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#169">source</a><a href="#method.poll_ready" class="anchor"></a><h4 class="code-header">fn <a href="../sink/trait.Sink.html#tymethod.poll_ready" class="fnname">poll_ready</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>></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" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#169">source</a><a href="#method.start_send" class="anchor"></a><h4 class="code-header">fn <a href="../sink/trait.Sink.html#tymethod.start_send" class="fnname">start_send</a>(self: Pin<&mut Self>, item: Item) -> Result<(), Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>></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_util/stream/stream/take_until.rs.html#169">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> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>></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_util/stream/stream/take_until.rs.html#169">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> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>></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><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Stream-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#111-148">source</a><a href="#impl-Stream-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,<br> Fut: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item" class="anchor"></a><h4 class="code-header">type <a href="trait.Stream.html#associatedtype.Item" class="associatedtype">Item</a> = <St as <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>>::<a class="associatedtype" href="trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a></h4></section></summary><div class='docblock'>Values yielded by the stream.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_next" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#118-139">source</a><a href="#method.poll_next" class="anchor"></a><h4 class="code-header">fn <a href="trait.Stream.html#tymethod.poll_next" class="fnname">poll_next</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Option<St::<a class="associatedtype" href="trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>>></h4></section></summary><div class='docblock'>Attempt to pull out the next value of this stream, registering the |
| current task for wakeup if the value is not yet available, and returning |
| <code>None</code> if the stream is exhausted. <a href="trait.Stream.html#tymethod.poll_next">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.size_hint" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#141-147">source</a><a href="#method.size_hint" class="anchor"></a><h4 class="code-header">fn <a href="trait.Stream.html#method.size_hint" class="fnname">size_hint</a>(&self) -> (usize, Option<usize>)</h4></section></summary><div class='docblock'>Returns the bounds on the remaining length of the stream. <a href="trait.Stream.html#method.size_hint">Read more</a></div></details></div></details><section id="impl-Unpin-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/stream/stream/take_until.rs.html#13-28">source</a><a href="#impl-Unpin-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<'__pin, St: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>, Fut: Future> Unpin for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> __Origin<'__pin, St, Fut>: Unpin,</span></h3></section></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-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> RefUnwindSafe for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> Fut: RefUnwindSafe,<br> St: RefUnwindSafe,<br> <Fut as Future>::Output: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-Send-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> Send for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> Fut: Send,<br> St: Send,<br> <Fut as Future>::Output: Send,</span></h3></section><section id="impl-Sync-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-Sync-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> Sync for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> Fut: Sync,<br> St: Sync,<br> <Fut as Future>::Output: Sync,</span></h3></section><section id="impl-UnwindSafe-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<St, Fut> UnwindSafe for <a class="struct" href="struct.TakeUntil.html" title="struct futures_util::stream::TakeUntil">TakeUntil</a><St, Fut><span class="where fmt-newline">where<br> Fut: UnwindSafe,<br> St: UnwindSafe,<br> <Fut as Future>::Output: UnwindSafe,</span></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-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-Any-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SinkExt%3CItem%3E-for-TakeUntil%3CSt%2C%20Fut%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-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T, Item> <a class="trait" href="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + ?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-85">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><U, Fut, F, E>(self, f: F) -> <a class="struct" href="../sink/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="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</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-126">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><U, St, F>(self, f: F) -> <a class="struct" href="../sink/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="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<Item, Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>>,<br> Self: Sized,</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-149">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><E, F>(self, f: F) -> <a class="struct" href="../sink/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="../sink/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'>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-160">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><E>(self) -> <a class="struct" href="../sink/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="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>: Into<E>,</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-180">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) -> <a class="struct" href="../sink/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'>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-188">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>(&mut self) -> <a class="struct" href="../sink/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="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="../sink/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="../sink/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'>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-201">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><Si>(self, other: Si) -> <a class="struct" href="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,</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-212">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>(&mut self) -> <a class="struct" href="../sink/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="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="../sink/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="../sink/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'>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-225">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>(&mut self, item: Item) -> <a class="struct" href="../sink/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="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="../sink/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="../sink/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'>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-238">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>(&mut self, item: Item) -> <a class="struct" href="../sink/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="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> + Unpin + ?Sized, Item> Future for <a class="struct" href="../sink/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="../sink/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'>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-261">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><'a, St>(&'a mut self, stream: &'a mut St) -> <a class="struct" href="../sink/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="../sink/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="../sink/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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Ok, Error = Error> + Unpin + ?Sized,<br> St: <a class="trait" href="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="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a><Ok = Item, Error = Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>> + <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> + Unpin + ?Sized,<br> 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-274">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><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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</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-287">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><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="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = Self::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,<br> Self: Sized,</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-307">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> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/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'>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-316">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>(&mut self, item: Item) -> Result<(), Self::<a class="associatedtype" href="../sink/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'>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-325">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> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/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'>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-334">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> &mut self,<br> cx: &mut Context<'_><br>) -> Poll<Result<(), Self::<a class="associatedtype" href="../sink/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'>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-TryFrom%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-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) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-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> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryStream-for-TakeUntil%3CSt%2C%20Fut%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/stream.rs.html#185">source</a><a href="#impl-TryStream-for-TakeUntil%3CSt%2C%20Fut%3E" class="anchor"></a><h3 class="code-header">impl<S, T, E> <a class="trait" href="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a> for S<span class="where fmt-newline">where<br> S: <a class="trait" href="trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = Result<T, E>> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Ok" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Ok" class="anchor"></a><h4 class="code-header">type <a href="trait.TryStream.html#associatedtype.Ok" class="associatedtype">Ok</a> = T</h4></section></summary><div class='docblock'>The type of successful values yielded by this future</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-3" class="anchor"></a><h4 class="code-header">type <a href="trait.TryStream.html#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section></summary><div class='docblock'>The type of failures yielded by this future</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_poll_next" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/stream.rs.html#192-195">source</a><a href="#method.try_poll_next" class="anchor"></a><h4 class="code-header">fn <a href="trait.TryStream.html#tymethod.try_poll_next" class="fnname">try_poll_next</a>(<br> self: Pin<&mut S>,<br> cx: &mut Context<'_><br>) -> Poll<Option<Result<<S as <a class="trait" href="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a>, <S as <a class="trait" href="trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="trait.TryStream.html#associatedtype.Error" title="type futures_util::stream::TryStream::Error">Error</a>>>></h4></section></summary><div class='docblock'>Poll this <code>TryStream</code> as if it were a <code>Stream</code>. <a href="trait.TryStream.html#tymethod.try_poll_next">Read more</a></div></details></div></details></div></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> |
