| <!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="Wraps a writer and buffers its output."><meta name="keywords" content="rust, rustlang, rust-lang, BufWriter"><title>BufWriter in futures_util::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">BufWriter</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.buffer">buffer</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.get_pin_mut">get_pin_mut</a></li><li><a href="#method.get_ref">get_ref</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.new">new</a></li><li><a href="#method.with_capacity">with_capacity</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsyncBufRead-for-BufWriter%3CW%3E">AsyncBufRead</a></li><li><a href="#impl-AsyncRead-for-BufWriter%3CW%3E">AsyncRead</a></li><li><a href="#impl-AsyncSeek-for-BufWriter%3CW%3E">AsyncSeek</a></li><li><a href="#impl-AsyncWrite-for-BufWriter%3CW%3E">AsyncWrite</a></li><li><a href="#impl-Debug-for-BufWriter%3CW%3E">Debug</a></li><li><a href="#impl-Unpin-for-BufWriter%3CW%3E">Unpin</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-BufWriter%3CW%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BufWriter%3CW%3E">Send</a></li><li><a href="#impl-Sync-for-BufWriter%3CW%3E">Sync</a></li><li><a href="#impl-UnwindSafe-for-BufWriter%3CW%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-BufWriter%3CW%3E">Any</a></li><li><a href="#impl-AsyncBufReadExt-for-BufWriter%3CW%3E">AsyncBufReadExt</a></li><li><a href="#impl-AsyncReadExt-for-BufWriter%3CW%3E">AsyncReadExt</a></li><li><a href="#impl-AsyncSeekExt-for-BufWriter%3CW%3E">AsyncSeekExt</a></li><li><a href="#impl-AsyncWriteExt-for-BufWriter%3CW%3E">AsyncWriteExt</a></li><li><a href="#impl-Borrow%3CT%3E-for-BufWriter%3CW%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-BufWriter%3CW%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-BufWriter%3CW%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-BufWriter%3CW%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-BufWriter%3CW%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-BufWriter%3CW%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In futures_util::io</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">futures_util</a>::<wbr><a href="index.html">io</a>::<wbr><a class="struct" href="#">BufWriter</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/io/buf_writer.rs.html#11-39">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct BufWriter<W> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Wraps a writer and buffers its output.</p> |
| <p>It can be excessively inefficient to work directly with something that |
| implements <a href="trait.AsyncWrite.html"><code>AsyncWrite</code></a>. A <code>BufWriter</code> keeps an in-memory buffer of data and |
| writes it to an underlying writer in large, infrequent batches.</p> |
| <p><code>BufWriter</code> can improve the speed of programs that make <em>small</em> and |
| <em>repeated</em> write calls to the same file or network socket. It does not |
| help when writing very large amounts at once, or writing just one or a few |
| times. It also provides no advantage when writing to a destination that is |
| in memory, like a <code>Vec<u8></code>.</p> |
| <p>When the <code>BufWriter</code> is dropped, the contents of its buffer will be |
| discarded. Creating multiple instances of a <code>BufWriter</code> on the same |
| stream can cause data loss. If you need to write out the contents of its |
| buffer, you must manually call flush before the writer is dropped.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#41-149">source</a><a href="#impl-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>> <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#44-46">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(inner: W) -> Self</h4></section></summary><div class="docblock"><p>Creates a new <code>BufWriter</code> with a default buffer capacity. The default is currently 8 KB, |
| but may change in the future.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_capacity" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#49-51">source</a><h4 class="code-header">pub fn <a href="#method.with_capacity" class="fnname">with_capacity</a>(cap: usize, inner: W) -> Self</h4></section></summary><div class="docblock"><p>Creates a new <code>BufWriter</code> with the specified buffer capacity.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#81">source</a><h4 class="code-header">pub fn <a href="#method.get_ref" class="fnname">get_ref</a>(&self) -> &W</h4></section></summary><div class="docblock"><p>Acquires a reference to the underlying sink or stream that this combinator is |
| pulling from.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#81">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> &mut W</h4></section></summary><div class="docblock"><p>Acquires a mutable reference to the underlying sink or stream that this |
| combinator is pulling from.</p> |
| <p>Note that care must be taken to avoid tampering with the state of the |
| sink or stream which may otherwise confuse this combinator.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_pin_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#81">source</a><h4 class="code-header">pub fn <a href="#method.get_pin_mut" class="fnname">get_pin_mut</a>(self: Pin<&mut Self>) -> Pin<&mut W><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for Pin<P></span><code class="content"><span class="where fmt-newline">impl<P> Future for Pin<P><span class="where fmt-newline">where<br> P: DerefMut,<br> <P as Deref>::Target: Future,</span></span><span class="where fmt-newline"> type <a class="associatedtype">Output</a> = <<P as Deref>::Target as Future>::Output;</span></code></span></span></span></span></h4></section></summary><div class="docblock"><p>Acquires a pinned mutable reference to the underlying sink or stream that this |
| combinator is pulling from.</p> |
| <p>Note that care must be taken to avoid tampering with the state of the |
| sink or stream which may otherwise confuse this combinator.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#81">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> W</h4></section></summary><div class="docblock"><p>Consumes this combinator, returning the underlying sink or stream.</p> |
| <p>Note that this may discard intermediate state of this combinator, so |
| care should be taken to avoid losing resources when this is called.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.buffer" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#84-86">source</a><h4 class="code-header">pub fn <a href="#method.buffer" class="fnname">buffer</a>(&self) -> &[u8]</h4></section></summary><div class="docblock"><p>Returns a reference to the internally buffered data.</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-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#198-200">source</a><a href="#impl-AsyncBufRead-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a>> <a class="trait" href="trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></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/io/buf_writer.rs.html#199">source</a><a href="#method.poll_fill_buf" class="anchor"></a><h4 class="code-header">fn <a href="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="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/io/buf_writer.rs.html#199">source</a><a href="#method.consume" class="anchor"></a><h4 class="code-header">fn <a href="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="trait.AsyncRead.html#tymethod.poll_read"><code>poll_read</code></a>. <a href="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-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#194-196">source</a><a href="#impl-AsyncRead-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a>> <a class="trait" href="trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></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/io/buf_writer.rs.html#195">source</a><a href="#method.poll_read" class="anchor"></a><h4 class="code-header">fn <a href="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="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/io/buf_writer.rs.html#195">source</a><a href="#method.poll_read_vectored" class="anchor"></a><h4 class="code-header">fn <a href="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="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-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#212-224">source</a><a href="#impl-AsyncSeek-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></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/io/buf_writer.rs.html#216-223">source</a><a href="#method.poll_seek" class="anchor"></a><h4 class="code-header">fn <a href="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"><p>Seek to the offset, in bytes, in the underlying writer.</p> |
| <p>Seeking always writes out the internal buffer before seeking.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsyncWrite-for-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#151-192">source</a><a href="#impl-AsyncWrite-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a>> <a class="trait" href="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></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/io/buf_writer.rs.html#152-165">source</a><a href="#method.poll_write" class="anchor"></a><h4 class="code-header">fn <a href="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="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/io/buf_writer.rs.html#167-181">source</a><a href="#method.poll_write_vectored" class="anchor"></a><h4 class="code-header">fn <a href="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="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" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#183-186">source</a><a href="#method.poll_flush" class="anchor"></a><h4 class="code-header">fn <a href="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="trait.AsyncWrite.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/io/buf_writer.rs.html#188-191">source</a><a href="#method.poll_close" class="anchor"></a><h4 class="code-header">fn <a href="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="trait.AsyncWrite.html#tymethod.poll_close">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#202-210">source</a><a href="#impl-Debug-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: Debug> Debug for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W></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/io/buf_writer.rs.html#203-209">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><section id="impl-Unpin-for-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/buf_writer.rs.html#11-39">source</a><a href="#impl-Unpin-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<'__pin, W> Unpin for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W><span class="where fmt-newline">where<br> __Origin<'__pin, W>: Unpin,</span></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W> RefUnwindSafe for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W><span class="where fmt-newline">where<br> W: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-Send-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W> Send for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W><span class="where fmt-newline">where<br> W: Send,</span></h3></section><section id="impl-Sync-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-Sync-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W> Sync for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W><span class="where fmt-newline">where<br> W: Sync,</span></h3></section><section id="impl-UnwindSafe-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W> UnwindSafe for <a class="struct" href="struct.BufWriter.html" title="struct futures_util::io::BufWriter">BufWriter</a><W><span class="where fmt-newline">where<br> W: 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-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-Any-for-BufWriter%3CW%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-BufWriter%3CW%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-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="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="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="trait.AsyncBufReadExt.html#method.fill_buf" class="fnname">fill_buf</a>(&mut self) -> <a class="struct" href="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="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="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="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="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="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="trait.AsyncBufRead.html#tymethod.consume" title="AsyncBufRead::consume"><code>AsyncBufRead::consume</code></a> on [<code>Unpin</code>] IO types. <a href="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="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="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="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="trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncBufReadExt.html#method.read_line" class="fnname">read_line</a><'a>(&'a mut self, buf: &'a mut String) -> <a class="struct" href="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="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="trait.AsyncBufRead.html" title="trait futures_util::io::AsyncBufRead">AsyncBufRead</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncBufReadExt.html#method.lines" class="fnname">lines</a>(self) -> <a class="struct" href="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="trait.AsyncBufReadExt.html#method.lines">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncReadExt-for-BufWriter%3CW%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-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<R> <a class="trait" href="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="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="trait.AsyncReadExt.html#method.chain" class="fnname">chain</a><R>(self, next: R) -> <a class="struct" href="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="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="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="trait.AsyncReadExt.html#method.read" class="fnname">read</a><'a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="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="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="trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="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="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="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="trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncReadExt.html#method.read_exact" class="fnname">read_exact</a><'a>(&'a mut self, buf: &'a mut [u8]) -> <a class="struct" href="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="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="trait.AsyncRead.html" title="trait futures_util::io::AsyncRead">AsyncRead</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="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="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="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="struct.ReadToEnd.html" title="struct futures_util::io::ReadToEnd">ReadToEnd</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="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="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="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="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="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="struct.ReadToString.html" title="struct futures_util::io::ReadToString">ReadToString</a><'_, A><span class="where fmt-newline">where<br> A: <a class="trait" href="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="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="trait.AsyncReadExt.html#method.split" class="fnname">split</a>(self) -> (<a class="struct" href="struct.ReadHalf.html" title="struct futures_util::io::ReadHalf">ReadHalf</a><Self>, <a class="struct" href="struct.WriteHalf.html" title="struct futures_util::io::WriteHalf">WriteHalf</a><Self>)<span class="where fmt-newline">where<br> Self: <a class="trait" href="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="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="trait.AsyncReadExt.html#method.take" class="fnname">take</a>(self, limit: u64) -> <a class="struct" href="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="trait.AsyncReadExt.html#method.take">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-AsyncSeekExt-for-BufWriter%3CW%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-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<S> <a class="trait" href="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="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="trait.AsyncSeekExt.html#method.seek" class="fnname">seek</a>(&mut self, pos: SeekFrom) -> <a class="struct" href="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="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="trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncSeekExt.html#method.stream_position" class="fnname">stream_position</a>(&mut self) -> <a class="struct" href="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="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="trait.AsyncSeek.html" title="trait futures_util::io::AsyncSeek">AsyncSeek</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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-BufWriter%3CW%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-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W> <a class="trait" href="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="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" 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" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncWriteExt.html#method.flush" class="fnname">flush</a>(&mut self) -> <a class="struct" href="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="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="struct.Flush.html" title="struct futures_util::io::Flush">Flush</a><'_, W><span class="where fmt-newline">where<br> W: <a class="trait" href="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="trait.AsyncWriteExt.html#method.flush">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/io/mod.rs.html#432-437">source</a><a href="#method.close" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncWriteExt.html#method.close" class="fnname">close</a>(&mut self) -> <a class="struct" href="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="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="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="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="trait.AsyncWriteExt.html#method.write" class="fnname">write</a><'a>(&'a mut self, buf: &'a [u8]) -> <a class="struct" href="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="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="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="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="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="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="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncWriteExt.html#method.write_all" class="fnname">write_all</a><'a>(&'a mut self, buf: &'a [u8]) -> <a class="struct" href="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="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="trait.AsyncWrite.html" title="trait futures_util::io::AsyncWrite">AsyncWrite</a> + ?Sized + Unpin> Future for <a class="struct" href="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="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="trait.AsyncWriteExt.html#method.into_sink" class="fnname">into_sink</a><Item: AsRef<[u8]>>(self) -> <a class="struct" href="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="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="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-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-BufWriter%3CW%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-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-BufWriter%3CW%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-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-BufWriter%3CW%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-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-BufWriter%3CW%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-TryFrom%3CU%3E-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-BufWriter%3CW%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-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> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-BufWriter%3CW%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-BufWriter%3CW%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" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" 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></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> |