| <!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="Combines two different futures, streams, or sinks having the same associated types into a single type."><meta name="keywords" content="rust, rustlang, rust-lang, Either"><title>Either in futures_util::future - 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 enum"><!--[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="#">Either</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.Left">Left</a></li><li><a href="#variant.Right">Right</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_pin_mut">as_pin_mut</a></li><li><a href="#method.as_pin_ref">as_pin_ref</a></li><li><a href="#method.factor_first">factor_first</a></li><li><a href="#method.factor_second">factor_second</a></li><li><a href="#method.into_inner">into_inner</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsyncBufRead-for-Either%3CA%2C%20B%3E">AsyncBufRead</a></li><li><a href="#impl-AsyncRead-for-Either%3CA%2C%20B%3E">AsyncRead</a></li><li><a href="#impl-AsyncSeek-for-Either%3CA%2C%20B%3E">AsyncSeek</a></li><li><a href="#impl-AsyncWrite-for-Either%3CA%2C%20B%3E">AsyncWrite</a></li><li><a href="#impl-Clone-for-Either%3CA%2C%20B%3E">Clone</a></li><li><a href="#impl-Debug-for-Either%3CA%2C%20B%3E">Debug</a></li><li><a href="#impl-FusedFuture-for-Either%3CA%2C%20B%3E">FusedFuture</a></li><li><a href="#impl-FusedStream-for-Either%3CA%2C%20B%3E">FusedStream</a></li><li><a href="#impl-Future-for-Either%3CA%2C%20B%3E">Future</a></li><li><a href="#impl-Sink%3CItem%3E-for-Either%3CA%2C%20B%3E">Sink<Item></a></li><li><a href="#impl-Stream-for-Either%3CA%2C%20B%3E">Stream</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Either%3CA%2C%20B%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Either%3CA%2C%20B%3E">Send</a></li><li><a href="#impl-Sync-for-Either%3CA%2C%20B%3E">Sync</a></li><li><a href="#impl-Unpin-for-Either%3CA%2C%20B%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Either%3CA%2C%20B%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Either%3CA%2C%20B%3E">Any</a></li><li><a href="#impl-AsyncBufReadExt-for-Either%3CA%2C%20B%3E">AsyncBufReadExt</a></li><li><a href="#impl-AsyncReadExt-for-Either%3CA%2C%20B%3E">AsyncReadExt</a></li><li><a href="#impl-AsyncSeekExt-for-Either%3CA%2C%20B%3E">AsyncSeekExt</a></li><li><a href="#impl-AsyncWriteExt-for-Either%3CA%2C%20B%3E">AsyncWriteExt</a></li><li><a href="#impl-Borrow%3CT%3E-for-Either%3CA%2C%20B%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Either%3CA%2C%20B%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Either%3CA%2C%20B%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Either%3CA%2C%20B%3E">Into<U></a></li><li><a href="#impl-IntoFuture-for-Either%3CA%2C%20B%3E">IntoFuture</a></li><li><a href="#impl-SinkExt%3CItem%3E-for-Either%3CA%2C%20B%3E">SinkExt<Item></a></li><li><a href="#impl-ToOwned-for-Either%3CA%2C%20B%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Either%3CA%2C%20B%3E">TryFrom<U></a></li><li><a href="#impl-TryFuture-for-Either%3CA%2C%20B%3E">TryFuture</a></li><li><a href="#impl-TryInto%3CU%3E-for-Either%3CA%2C%20B%3E">TryInto<U></a></li><li><a href="#impl-TryStream-for-Either%3CA%2C%20B%3E">TryStream</a></li></ul></section><h2><a href="index.html">In futures_util::future</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">Enum <a href="../index.html">futures_util</a>::<wbr><a href="index.html">future</a>::<wbr><a class="enum" href="#">Either</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/future/either.rs.html#28-33">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 enum"><code>pub enum Either<A, B> { |
| Left(A), |
| Right(B), |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Combines two different futures, streams, or sinks having the same associated types into a single type.</p> |
| <p>This is useful when conditionally choosing between two distinct future types:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future::Either; |
| |
| <span class="kw">let </span>cond = <span class="bool-val">true</span>; |
| |
| <span class="kw">let </span>fut = <span class="kw">if </span>cond { |
| Either::Left(<span class="kw">async move </span>{ <span class="number">12 </span>}) |
| } <span class="kw">else </span>{ |
| Either::Right(<span class="kw">async move </span>{ <span class="number">44 </span>}) |
| }; |
| |
| <span class="macro">assert_eq!</span>(fut.<span class="kw">await</span>, <span class="number">12</span>);</code></pre></div> |
| </div></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.Left" class="variant small-section-header"><a href="#variant.Left" class="anchor field"></a><code>Left(A)</code></h3><div class="docblock"><p>First branch of the type</p> |
| </div><h3 id="variant.Right" class="variant small-section-header"><a href="#variant.Right" class="anchor field"></a><code>Right(B)</code></h3><div class="docblock"><p>Second branch of the type</p> |
| </div><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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#35-64">source</a><a href="#impl-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_pin_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#38-47">source</a><h4 class="code-header">pub fn <a href="#method.as_pin_ref" class="fnname">as_pin_ref</a>(self: Pin<&Self>) -> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><Pin<&A>, Pin<&B>><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="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="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></h4></section></summary><div class="docblock"><p>Convert <code>Pin<&Either<A, B>></code> to <code>Either<Pin<&A>, Pin<&B>></code>, |
| pinned projections of the inner variants.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_pin_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#51-63">source</a><h4 class="code-header">pub fn <a href="#method.as_pin_mut" class="fnname">as_pin_mut</a>(self: Pin<&mut Self>) -> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><Pin<&mut A>, Pin<&mut B>><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="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="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></h4></section></summary><div class="docblock"><p>Convert <code>Pin<&mut Either<A, B>></code> to <code>Either<Pin<&mut A>, Pin<&mut B>></code>, |
| pinned projections of the inner variants.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Either%3C(T%2C%20A)%2C%20(T%2C%20B)%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#66-76">source</a><a href="#impl-Either%3C(T%2C%20A)%2C%20(T%2C%20B)%3E" class="anchor"></a><h3 class="code-header">impl<A, B, T> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><(T, A), (T, B)></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.factor_first" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#70-75">source</a><h4 class="code-header">pub fn <a href="#method.factor_first" class="fnname">factor_first</a>(self) -> (T, <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B>)</h4></section></summary><div class="docblock"><p>Factor out a homogeneous type from an either of pairs.</p> |
| <p>Here, the homogeneous type is the first element of the pairs.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Either%3C(A%2C%20T)%2C%20(B%2C%20T)%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#78-88">source</a><a href="#impl-Either%3C(A%2C%20T)%2C%20(B%2C%20T)%3E" class="anchor"></a><h3 class="code-header">impl<A, B, T> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><(A, T), (B, T)></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.factor_second" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#82-87">source</a><h4 class="code-header">pub fn <a href="#method.factor_second" class="fnname">factor_second</a>(self) -> (<a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B>, T)</h4></section></summary><div class="docblock"><p>Factor out a homogeneous type from an either of pairs.</p> |
| <p>Here, the homogeneous type is the second element of the pairs.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Either%3CT%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#90-98">source</a><a href="#impl-Either%3CT%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><T, T></h3></section></summary><div class="impl-items"><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/future/either.rs.html#92-97">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> T</h4></section></summary><div class="docblock"><p>Extract the value of an either over two equivalent types.</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-AsyncBufRead-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#298-316">source</a><a href="#impl-AsyncBufRead-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a>,<br> B: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_fill_buf" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#303-308">source</a><a href="#method.poll_fill_buf" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufRead.html#tymethod.poll_fill_buf" class="fnname">poll_fill_buf</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Result<&[u8]>></h4></section></summary><div class='docblock'>Attempt to return the contents of the internal buffer, filling it with more data |
| from the inner reader if it is empty. <a href="../io/trait.AsyncBufRead.html#tymethod.poll_fill_buf">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.consume" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#310-315">source</a><a href="#method.consume" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufRead.html#tymethod.consume" class="fnname">consume</a>(self: Pin<&mut Self>, amt: usize)</h4></section></summary><div class='docblock'>Tells this buffer that <code>amt</code> bytes have been consumed from the buffer, |
| so they should no longer be returned in calls to <a href="../io/trait.AsyncRead.html#tymethod.poll_read"><code>poll_read</code></a>. <a href="../io/trait.AsyncBufRead.html#tymethod.consume">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncRead-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#211-237">source</a><a href="#impl-AsyncRead-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>,<br> B: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#216-225">source</a><a href="#method.poll_read" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncRead.html#tymethod.poll_read" class="fnname">poll_read</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_>,<br> buf: &mut [u8]<br>) -> Poll<Result<usize>></h4></section></summary><div class='docblock'>Attempt to read from the <code>AsyncRead</code> into <code>buf</code>. <a href="../io/trait.AsyncRead.html#tymethod.poll_read">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_read_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#227-236">source</a><a href="#method.poll_read_vectored" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncRead.html#method.poll_read_vectored" class="fnname">poll_read_vectored</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_>,<br> bufs: &mut [IoSliceMut<'_>]<br>) -> Poll<Result<usize>></h4></section></summary><div class='docblock'>Attempt to read from the <code>AsyncRead</code> into <code>bufs</code> using vectored |
| IO operations. <a href="../io/trait.AsyncRead.html#method.poll_read_vectored">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncSeek-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#281-296">source</a><a href="#impl-AsyncSeek-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a>,<br> B: <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_seek" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#286-295">source</a><a href="#method.poll_seek" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncSeek.html#tymethod.poll_seek" class="fnname">poll_seek</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_>,<br> pos: SeekFrom<br>) -> Poll<Result<u64>></h4></section></summary><div class='docblock'>Attempt to seek to an offset, in bytes, in a stream. <a href="../io/trait.AsyncSeek.html#tymethod.poll_seek">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncWrite-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#239-279">source</a><a href="#impl-AsyncWrite-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>,<br> B: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_write" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#244-253">source</a><a href="#method.poll_write" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWrite.html#tymethod.poll_write" class="fnname">poll_write</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_>,<br> buf: &[u8]<br>) -> Poll<Result<usize>></h4></section></summary><div class='docblock'>Attempt to write bytes from <code>buf</code> into the object. <a href="../io/trait.AsyncWrite.html#tymethod.poll_write">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_write_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#255-264">source</a><a href="#method.poll_write_vectored" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWrite.html#method.poll_write_vectored" class="fnname">poll_write_vectored</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_>,<br> bufs: &[IoSlice<'_>]<br>) -> Poll<Result<usize>></h4></section></summary><div class='docblock'>Attempt to write bytes from <code>bufs</code> into the object using vectored |
| IO operations. <a href="../io/trait.AsyncWrite.html#method.poll_write_vectored">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_flush-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#266-271">source</a><a href="#method.poll_flush-1" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWrite.html#tymethod.poll_flush" class="fnname">poll_flush</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>></h4></section></summary><div class='docblock'>Attempt to flush the object, ensuring that any buffered data reach |
| their destination. <a href="../io/trait.AsyncWrite.html#tymethod.poll_flush">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_close-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#273-278">source</a><a href="#method.poll_close-1" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWrite.html#tymethod.poll_close" class="fnname">poll_close</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>></h4></section></summary><div class='docblock'>Attempt to close the object. <a href="../io/trait.AsyncWrite.html#tymethod.poll_close">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#27">source</a><a href="#impl-Clone-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A: Clone, B: Clone> Clone for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#27">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><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="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="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></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#27">source</a><a href="#impl-Debug-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A: Debug, B: Debug> Debug for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B></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/future/either.rs.html#27">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-FusedFuture-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#115-126">source</a><a href="#impl-FusedFuture-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="trait.FusedFuture.html" title="trait futures_util::future::FusedFuture">FusedFuture</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="trait.FusedFuture.html" title="trait futures_util::future::FusedFuture">FusedFuture</a>,<br> B: <a class="trait" href="trait.FusedFuture.html" title="trait futures_util::future::FusedFuture">FusedFuture</a><Output = A::Output>,</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/future/either.rs.html#120-125">source</a><a href="#method.is_terminated" class="anchor"></a><h4 class="code-header">fn <a href="trait.FusedFuture.html#tymethod.is_terminated" class="fnname">is_terminated</a>(&self) -> bool</h4></section></summary><div class='docblock'>Returns <code>true</code> if the underlying future should no longer be polled.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FusedStream-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#150-161">source</a><a href="#impl-FusedStream-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../stream/trait.FusedStream.html" title="trait futures_util::stream::FusedStream">FusedStream</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../stream/trait.FusedStream.html" title="trait futures_util::stream::FusedStream">FusedStream</a>,<br> B: <a class="trait" href="../stream/trait.FusedStream.html" title="trait futures_util::stream::FusedStream">FusedStream</a><Item = A::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_terminated-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#155-160">source</a><a href="#method.is_terminated-1" class="anchor"></a><h4 class="code-header">fn <a href="../stream/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-Future-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#100-113">source</a><a href="#impl-Future-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> Future for <a class="enum" href="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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <A as Future>::Output</h4></section></summary><div class='docblock'>The type of value produced on completion.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#107-112">source</a><a href="#method.poll" class="anchor"></a><h4 class="code-header">fn <a class="fnname">poll</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output></h4></section></summary><div class='docblock'>Attempt to resolve the future to a final value, registering |
| the current task for wakeup if the value is not yet available. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Sink%3CItem%3E-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#164-198">source</a><a href="#impl-Sink%3CItem%3E-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B, Item> <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item>,<br> B: <a class="trait" href="../sink/trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a><Item, Error = A::<a class="associatedtype" href="../sink/trait.Sink.html#associatedtype.Error" title="type futures_util::sink::Sink::Error">Error</a>>,</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> = <A 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/future/either.rs.html#171-176">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/future/either.rs.html#178-183">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/future/either.rs.html#185-190">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/future/either.rs.html#192-197">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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/either.rs.html#128-148">source</a><a href="#impl-Stream-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a> for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>,<br> B: <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a><Item = A::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Item" title="type futures_util::stream::Stream::Item">Item</a>>,</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="../stream/trait.Stream.html#associatedtype.Item" class="associatedtype">Item</a> = <A as <a class="trait" href="../stream/trait.Stream.html" title="trait futures_util::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/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/future/either.rs.html#135-140">source</a><a href="#method.poll_next" class="anchor"></a><h4 class="code-header">fn <a href="../stream/trait.Stream.html#tymethod.poll_next" class="fnname">poll_next</a>(<br> self: Pin<&mut Self>,<br> cx: &mut Context<'_><br>) -> Poll<Option<Self::<a class="associatedtype" href="../stream/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="../stream/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/future/either.rs.html#142-147">source</a><a href="#method.size_hint" class="anchor"></a><h4 class="code-header">fn <a href="../stream/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="../stream/trait.Stream.html#method.size_hint">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> RefUnwindSafe for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: RefUnwindSafe,<br> B: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Send-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> Send for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Send,<br> B: Send,</span></h3></section><section id="impl-Sync-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Sync-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> Sync for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Sync,<br> B: Sync,</span></h3></section><section id="impl-Unpin-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> Unpin for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: Unpin,<br> B: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<A, B> UnwindSafe for <a class="enum" href="enum.Either.html" title="enum futures_util::future::Either">Either</a><A, B><span class="where fmt-newline">where<br> A: UnwindSafe,<br> B: 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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Any-for-Either%3CA%2C%20B%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-AsyncBufReadExt-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#824">source</a><a href="#impl-AsyncBufReadExt-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="../io/trait.AsyncBufReadExt.html" title="trait futures_util::io::AsyncBufReadExt">AsyncBufReadExt</a> for R<span class="where fmt-newline">where<br> R: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fill_buf" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#647-652">source</a><a href="#method.fill_buf" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufReadExt.html#method.fill_buf" class="fnname">fill_buf</a>(&mut self) -> <a class="struct" href="../io/struct.FillBuf.html" title="struct futures_util::io::FillBuf">FillBuf</a><'_, 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="struct" href="../io/struct.FillBuf.html" title="struct futures_util::io::FillBuf">FillBuf</a><'a, R></span><code class="content"><span class="where fmt-newline">impl<'a, R> Future for <a class="struct" href="../io/struct.FillBuf.html" title="struct futures_util::io::FillBuf">FillBuf</a><'a, R><span class="where fmt-newline">where<br> R: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized + Unpin,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<&'a [u8]>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will wait for a non-empty buffer to be available from this I/O |
| object or EOF to be reached. <a href="../io/trait.AsyncBufReadExt.html#method.fill_buf">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.consume_unpin" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#671-676">source</a><a href="#method.consume_unpin" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufReadExt.html#method.consume_unpin" class="fnname">consume_unpin</a>(&mut self, amt: usize)<span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>A convenience for calling <a href="../io/trait.AsyncBufRead.html#tymethod.consume" title="AsyncBufRead::consume"><code>AsyncBufRead::consume</code></a> on [<code>Unpin</code>] IO types. <a href="../io/trait.AsyncBufReadExt.html#method.consume_unpin">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_until" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#719-724">source</a><a href="#method.read_until" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufReadExt.html#method.read_until" class="fnname">read_until</a><'a>(<br> &'a mut self,<br> byte: u8,<br> buf: &'a mut Vec<u8><br>) -> <a class="struct" href="../io/struct.ReadUntil.html" title="struct futures_util::io::ReadUntil">ReadUntil</a><'a, 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="struct" href="../io/struct.ReadUntil.html" title="struct futures_util::io::ReadUntil">ReadUntil</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.ReadUntil.html" title="struct futures_util::io::ReadUntil">ReadUntil</a><'_, R></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes associated with this I/O |
| object into <code>buf</code> until the delimiter <code>byte</code> or EOF is reached. |
| This method is the async equivalent to <a href="std::io::BufRead::read_until"><code>BufRead::read_until</code></a>. <a href="../io/trait.AsyncBufReadExt.html#method.read_until">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_line" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#777-782">source</a><a href="#method.read_line" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufReadExt.html#method.read_line" class="fnname">read_line</a><'a>(&'a mut self, buf: &'a mut String) -> <a class="struct" href="../io/struct.ReadLine.html" title="struct futures_util::io::ReadLine">ReadLine</a><'a, 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="struct" href="../io/struct.ReadLine.html" title="struct futures_util::io::ReadLine">ReadLine</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R: <a class="trait" href="../io/trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.ReadLine.html" title="struct futures_util::io::ReadLine">ReadLine</a><'_, R></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes associated with this I/O |
| object into <code>buf</code> until a newline (the 0xA byte) or EOF is reached, |
| This method is the async equivalent to <a href="std::io::BufRead::read_line"><code>BufRead::read_line</code></a>. <a href="../io/trait.AsyncBufReadExt.html#method.read_line">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lines" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#816-821">source</a><a href="#method.lines" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncBufReadExt.html#method.lines" class="fnname">lines</a>(self) -> <a class="struct" href="../io/struct.Lines.html" title="struct futures_util::io::Lines">Lines</a><Self><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Returns a stream over the lines of this reader. |
| This method is the async equivalent to <a href="std::io::BufRead::lines"><code>BufRead::lines</code></a>. <a href="../io/trait.AsyncBufReadExt.html#method.lines">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncReadExt-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#398">source</a><a href="#impl-AsyncReadExt-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="../io/trait.AsyncReadExt.html" title="trait futures_util::io::AsyncReadExt">AsyncReadExt</a> for R<span class="where fmt-newline">where<br> R: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.chain" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#172-178">source</a><a href="#method.chain" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.chain" class="fnname">chain</a><R>(self, next: R) -> <a class="struct" href="../io/struct.Chain.html" title="struct futures_util::io::Chain">Chain</a><Self, R><span class="where fmt-newline">where<br> Self: Sized,<br> R: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>,</span></h4></section></summary><div class='docblock'>Creates an adaptor which will chain this stream with another. <a href="../io/trait.AsyncReadExt.html#method.chain">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#204-209">source</a><a href="#method.read" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.read" class="fnname">read</a><'a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="../io/struct.Read.html" title="struct futures_util::io::Read">Read</a><'a, 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="struct" href="../io/struct.Read.html" title="struct futures_util::io::Read">Read</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.Read.html" title="struct futures_util::io::Read">Read</a><'_, R></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Tries to read some bytes directly into the given <code>buf</code> in asynchronous |
| manner, returning a future type. <a href="../io/trait.AsyncReadExt.html#method.read">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#216-221">source</a><a href="#method.read_vectored" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.read_vectored" class="fnname">read_vectored</a><'a>(<br> &'a mut self,<br> bufs: &'a mut [IoSliceMut<'a>]<br>) -> <a class="struct" href="../io/struct.ReadVectored.html" title="struct futures_util::io::ReadVectored">ReadVectored</a><'a, 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="struct" href="../io/struct.ReadVectored.html" title="struct futures_util::io::ReadVectored">ReadVectored</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.ReadVectored.html" title="struct futures_util::io::ReadVectored">ReadVectored</a><'_, R></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read from the <code>AsyncRead</code> into <code>bufs</code> using vectored |
| IO operations. <a href="../io/trait.AsyncReadExt.html#method.read_vectored">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_exact" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#260-265">source</a><a href="#method.read_exact" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.read_exact" class="fnname">read_exact</a><'a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="../io/struct.ReadExact.html" title="struct futures_util::io::ReadExact">ReadExact</a><'a, 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="struct" href="../io/struct.ReadExact.html" title="struct futures_util::io::ReadExact">ReadExact</a><'_, R></span><code class="content"><span class="where fmt-newline">impl<R: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.ReadExact.html" title="struct futures_util::io::ReadExact">ReadExact</a><'_, R></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<()>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read exactly enough bytes to fill <code>buf</code>, |
| returning an error if end of file (EOF) is hit sooner. <a href="../io/trait.AsyncReadExt.html#method.read_exact">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_end" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#286-291">source</a><a href="#method.read_to_end" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.read_to_end" class="fnname">read_to_end</a><'a>(&'a mut self, buf: &'a mut Vec<u8>) -> <a class="struct" href="../io/struct.ReadToEnd.html" title="struct futures_util::io::ReadToEnd">ReadToEnd</a><'a, 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="struct" href="../io/struct.ReadToEnd.html" title="struct futures_util::io::ReadToEnd">ReadToEnd</a><'_, A></span><code class="content"><span class="where fmt-newline">impl<A> Future for <a class="struct" href="../io/struct.ReadToEnd.html" title="struct futures_util::io::ReadToEnd">ReadToEnd</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes from this <code>AsyncRead</code>. <a href="../io/trait.AsyncReadExt.html#method.read_to_end">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_to_string" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#312-317">source</a><a href="#method.read_to_string" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.read_to_string" class="fnname">read_to_string</a><'a>(<br> &'a mut self,<br> buf: &'a mut String<br>) -> <a class="struct" href="../io/struct.ReadToString.html" title="struct futures_util::io::ReadToString">ReadToString</a><'a, 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="struct" href="../io/struct.ReadToString.html" title="struct futures_util::io::ReadToString">ReadToString</a><'_, A></span><code class="content"><span class="where fmt-newline">impl<A> Future for <a class="struct" href="../io/struct.ReadToString.html" title="struct futures_util::io::ReadToString">ReadToString</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="../io/trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will read all the bytes from this <code>AsyncRead</code>. <a href="../io/trait.AsyncReadExt.html#method.read_to_string">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.split" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#348-354">source</a><a href="#method.split" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.split" class="fnname">split</a>(self) -> (<a class="struct" href="../io/struct.ReadHalf.html" title="struct futures_util::io::ReadHalf">ReadHalf</a><Self>, <a class="struct" href="../io/struct.WriteHalf.html" title="struct futures_util::io::WriteHalf">WriteHalf</a><Self>)<span class="where fmt-newline">where<br> Self: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + Sized,</span></h4></section></summary><div class='docblock'>Helper method for splitting this read/write object into two halves. <a href="../io/trait.AsyncReadExt.html#method.split">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.take" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#375-380">source</a><a href="#method.take" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncReadExt.html#method.take" class="fnname">take</a>(self, limit: u64) -> <a class="struct" href="../io/struct.Take.html" title="struct futures_util::io::Take">Take</a><Self><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Creates an AsyncRead adapter which will read at most <code>limit</code> bytes |
| from the underlying reader. <a href="../io/trait.AsyncReadExt.html#method.take">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncSeekExt-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#620">source</a><a href="#impl-AsyncSeekExt-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<S> <a class="trait" href="../io/trait.AsyncSeekExt.html" title="trait futures_util::io::AsyncSeekExt">AsyncSeekExt</a> for S<span class="where fmt-newline">where<br> S: <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.seek" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#601-606">source</a><a href="#method.seek" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncSeekExt.html#method.seek" class="fnname">seek</a>(&mut self, pos: SeekFrom) -> <a class="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, 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="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, S></span><code class="content"><span class="where fmt-newline">impl<S: <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, S></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<u64>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will seek an IO object, and then yield the |
| new position in the object and the object itself. <a href="../io/trait.AsyncSeekExt.html#method.seek">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stream_position" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#612-617">source</a><a href="#method.stream_position" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncSeekExt.html#method.stream_position" class="fnname">stream_position</a>(&mut self) -> <a class="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, 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="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, S></span><code class="content"><span class="where fmt-newline">impl<S: <a class="trait" href="../io/trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.Seek.html" title="struct futures_util::io::Seek">Seek</a><'_, S></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<u64>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will return the current seek position from the |
| start of the stream. <a href="../io/trait.AsyncSeekExt.html#method.stream_position">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncWriteExt-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#592">source</a><a href="#impl-AsyncWriteExt-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<W> <a class="trait" href="../io/trait.AsyncWriteExt.html" title="trait futures_util::io::AsyncWriteExt">AsyncWriteExt</a> for W<span class="where fmt-newline">where<br> W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.flush-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#424-429">source</a><a href="#method.flush-1" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.flush" class="fnname">flush</a>(&mut self) -> <a class="struct" href="../io/struct.Flush.html" title="struct futures_util::io::Flush">Flush</a><'_, 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="struct" href="../io/struct.Flush.html" title="struct futures_util::io::Flush">Flush</a><'_, W></span><code class="content"><span class="where fmt-newline">impl<W> Future for <a class="struct" href="../io/struct.Flush.html" title="struct futures_util::io::Flush">Flush</a><'_, W><span class="where fmt-newline">where<br> W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<()>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will entirely flush this <code>AsyncWrite</code>. <a href="../io/trait.AsyncWriteExt.html#method.flush">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.close-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#432-437">source</a><a href="#method.close-1" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.close" class="fnname">close</a>(&mut self) -> <a class="struct" href="../io/struct.Close.html" title="struct futures_util::io::Close">Close</a><'_, 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="struct" href="../io/struct.Close.html" title="struct futures_util::io::Close">Close</a><'_, W></span><code class="content"><span class="where fmt-newline">impl<W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.Close.html" title="struct futures_util::io::Close">Close</a><'_, W></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<()>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will entirely close this <code>AsyncWrite</code>.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#443-448">source</a><a href="#method.write" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.write" class="fnname">write</a><'a>(&'a mut self, buf: &'a [u8]) -> <a class="struct" href="../io/struct.Write.html" title="struct futures_util::io::Write">Write</a><'a, 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="struct" href="../io/struct.Write.html" title="struct futures_util::io::Write">Write</a><'_, W></span><code class="content"><span class="where fmt-newline">impl<W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.Write.html" title="struct futures_util::io::Write">Write</a><'_, W></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will write bytes from <code>buf</code> into the object. <a href="../io/trait.AsyncWriteExt.html#method.write">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#455-460">source</a><a href="#method.write_vectored" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.write_vectored" class="fnname">write_vectored</a><'a>(<br> &'a mut self,<br> bufs: &'a [IoSlice<'a>]<br>) -> <a class="struct" href="../io/struct.WriteVectored.html" title="struct futures_util::io::WriteVectored">WriteVectored</a><'a, 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="struct" href="../io/struct.WriteVectored.html" title="struct futures_util::io::WriteVectored">WriteVectored</a><'_, W></span><code class="content"><span class="where fmt-newline">impl<W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.WriteVectored.html" title="struct futures_util::io::WriteVectored">WriteVectored</a><'_, W></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<usize>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Creates a future which will write bytes from <code>bufs</code> into the object using vectored |
| IO operations. <a href="../io/trait.AsyncWriteExt.html#method.write_vectored">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_all" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#482-487">source</a><a href="#method.write_all" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.write_all" class="fnname">write_all</a><'a>(&'a mut self, buf: &'a [u8]) -> <a class="struct" href="../io/struct.WriteAll.html" title="struct futures_util::io::WriteAll">WriteAll</a><'a, 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="struct" href="../io/struct.WriteAll.html" title="struct futures_util::io::WriteAll">WriteAll</a><'_, W></span><code class="content"><span class="where fmt-newline">impl<W: <a class="trait" href="../io/trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="../io/struct.WriteAll.html" title="struct futures_util::io::WriteAll">WriteAll</a><'_, W></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = Result<()>;</span></code></span></span></span></span><span class="where fmt-newline">where<br> Self: Unpin,</span></h4></section></summary><div class='docblock'>Write data into this object. <a href="../io/trait.AsyncWriteExt.html#method.write_all">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_sink" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/mod.rs.html#584-589">source</a><a href="#method.into_sink" class="anchor"></a><h4 class="code-header">fn <a href="../io/trait.AsyncWriteExt.html#method.into_sink" class="fnname">into_sink</a><Item: AsRef<[u8]>>(self) -> <a class="struct" href="../io/struct.IntoSink.html" title="struct futures_util::io::IntoSink">IntoSink</a><Self, Item><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Allow using an <a href="../io/trait.AsyncWrite.html" title="AsyncWrite"><code>AsyncWrite</code></a> as a <a href="../sink/trait.Sink.html"><code>Sink</code></a><code><Item: AsRef<[u8]>></code>. <a href="../io/trait.AsyncWriteExt.html#method.into_sink">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Either%3CA%2C%20B%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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Either%3CA%2C%20B%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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Either%3CA%2C%20B%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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Either%3CA%2C%20B%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-IntoFuture-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-IntoFuture-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<F> IntoFuture for F<span class="where fmt-newline">where<br> F: Future,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Output</a> = <F as Future>::Output</h4></section></summary><div class='docblock'>The output that the future will produce on completion.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.IntoFuture" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.IntoFuture" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">IntoFuture</a> = F</h4></section></summary><div class='docblock'>Which kind of future are we turning this into?</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_future" class="method trait-impl has-srclink"><a href="#method.into_future" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_future</a>(self) -> <F as IntoFuture>::IntoFuture</h4></section></summary><div class='docblock'>Creates a future from a value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-SinkExt%3CItem%3E-for-Either%3CA%2C%20B%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-Either%3CA%2C%20B%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="../stream/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="../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="../sink/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'>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="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="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="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="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="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="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-ToOwned-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Either%3CA%2C%20B%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-TryFuture-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#73">source</a><a href="#impl-TryFuture-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<F, T, E> <a class="trait" href="trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a> for F<span class="where fmt-newline">where<br> F: Future<Output = 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.TryFuture.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.TryFuture.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" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#81">source</a><a href="#method.try_poll" class="anchor"></a><h4 class="code-header">fn <a href="trait.TryFuture.html#tymethod.try_poll" class="fnname">try_poll</a>(<br> self: Pin<&mut F>,<br> cx: &mut Context<'_><br>) -> Poll<<F as Future>::Output></h4></section></summary><div class='docblock'>Poll this <code>TryFuture</code> as if it were a <code>Future</code>. <a href="trait.TryFuture.html#tymethod.try_poll">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Either%3CA%2C%20B%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Either%3CA%2C%20B%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-Either%3CA%2C%20B%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/stream.rs.html#185">source</a><a href="#impl-TryStream-for-Either%3CA%2C%20B%3E" class="anchor"></a><h3 class="code-header">impl<S, T, E> <a class="trait" href="../stream/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="../stream/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-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Ok-1" class="anchor"></a><h4 class="code-header">type <a href="../stream/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-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-4" class="anchor"></a><h4 class="code-header">type <a href="../stream/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="../stream/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="../stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="../stream/trait.TryStream.html#associatedtype.Ok" title="type futures_util::stream::TryStream::Ok">Ok</a>, <S as <a class="trait" href="../stream/trait.TryStream.html" title="trait futures_util::stream::TryStream">TryStream</a>>::<a class="associatedtype" href="../stream/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="../stream/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> |
