| <!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 tokio::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="../../tokio/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="../../tokio/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-From%3CBufWriter%3CBufReader%3CRW%3E%3E%3E-for-BufStream%3CRW%3E">From<BufWriter<BufReader<RW>>></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-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 tokio::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">tokio</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/tokio/io/util/buf_writer.rs.html#10-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/tokio/io/util/buf_writer.rs.html#41-116">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 tokio::io::AsyncWrite">AsyncWrite</a>> <a class="struct" href="struct.BufWriter.html" title="struct tokio::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/tokio/io/util/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/tokio/io/util/buf_writer.rs.html#49-56">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/tokio/io/util/buf_writer.rs.html#87-89">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>Gets a reference to the underlying writer.</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/tokio/io/util/buf_writer.rs.html#94-96">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>Gets a mutable reference to the underlying writer.</p> |
| <p>It is inadvisable to directly write to the underlying writer.</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/tokio/io/util/buf_writer.rs.html#101-103">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>Gets a pinned mutable reference to the underlying writer.</p> |
| <p>It is inadvisable to directly write to the underlying writer.</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/tokio/io/util/buf_writer.rs.html#108-110">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 <code>BufWriter</code>, returning the underlying writer.</p> |
| <p>Note that any leftover data in the internal buffer is lost.</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/tokio/io/util/buf_writer.rs.html#113-115">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/tokio/io/util/buf_writer.rs.html#279-287">source</a><a href="#impl-AsyncBufRead-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncBufRead.html" title="trait tokio::io::AsyncBufRead">AsyncBufRead</a>> <a class="trait" href="trait.AsyncBufRead.html" title="trait tokio::io::AsyncBufRead">AsyncBufRead</a> for <a class="struct" href="struct.BufWriter.html" title="struct tokio::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/tokio/io/util/buf_writer.rs.html#280-282">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'>Attempts 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/tokio/io/util/buf_writer.rs.html#284-286">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/tokio/io/util/buf_writer.rs.html#269-277">source</a><a href="#impl-AsyncRead-for-BufWriter%3CW%3E" class="anchor"></a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a>> <a class="trait" href="trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a> for <a class="struct" href="struct.BufWriter.html" title="struct tokio::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/tokio/io/util/buf_writer.rs.html#270-276">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 <a class="struct" href="struct.ReadBuf.html" title="struct tokio::io::ReadBuf">ReadBuf</a><'_><br>) -> Poll<Result<()>></h4></section></summary><div class='docblock'>Attempts to read from the <code>AsyncRead</code> into <code>buf</code>. <a href="trait.AsyncRead.html#tymethod.poll_read">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/tokio/io/util/buf_writer.rs.html#226-267">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 tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.BufWriter.html" title="struct tokio::io::BufWriter">BufWriter</a><W></h3></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><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_seek" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_writer.rs.html#227-233">source</a><a href="#method.start_seek" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncSeek.html#tymethod.start_seek" class="fnname">start_seek</a>(self: Pin<&mut Self>, pos: SeekFrom) -> Result<()></h4></section></summary><div class='docblock'>Attempts to seek to an offset, in bytes, in a stream. <a href="trait.AsyncSeek.html#tymethod.start_seek">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll_complete" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_writer.rs.html#235-266">source</a><a href="#method.poll_complete" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncSeek.html#tymethod.poll_complete" class="fnname">poll_complete</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<u64>></h4></section></summary><div class='docblock'>Waits for a seek operation to complete. <a href="trait.AsyncSeek.html#tymethod.poll_complete">Read more</a></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/tokio/io/util/buf_writer.rs.html#118-211">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 tokio::io::AsyncWrite">AsyncWrite</a>> <a class="trait" href="trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> for <a class="struct" href="struct.BufWriter.html" title="struct tokio::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/tokio/io/util/buf_writer.rs.html#119-134">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/tokio/io/util/buf_writer.rs.html#136-196">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'>Like <a href="trait.AsyncWrite.html#tymethod.poll_write"><code>poll_write</code></a>, except that it writes from a slice of buffers. <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.is_write_vectored" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_writer.rs.html#198-200">source</a><a href="#method.is_write_vectored" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncWrite.html#method.is_write_vectored" class="fnname">is_write_vectored</a>(&self) -> bool</h4></section></summary><div class='docblock'>Determines if this writer has an efficient <a href="trait.AsyncWrite.html#method.poll_write_vectored"><code>poll_write_vectored</code></a> |
| implementation. <a href="trait.AsyncWrite.html#method.is_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/tokio/io/util/buf_writer.rs.html#202-205">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'>Attempts 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_shutdown" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_writer.rs.html#207-210">source</a><a href="#method.poll_shutdown" class="anchor"></a><h4 class="code-header">fn <a href="trait.AsyncWrite.html#tymethod.poll_shutdown" class="fnname">poll_shutdown</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>></h4></section></summary><div class='docblock'>Initiates or attempts to shut down this writer, returning success when |
| the I/O connection has completely shut down. <a href="trait.AsyncWrite.html#tymethod.poll_shutdown">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/tokio/io/util/buf_writer.rs.html#289-300">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 tokio::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/tokio/io/util/buf_writer.rs.html#290-299">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-From%3CBufWriter%3CBufReader%3CRW%3E%3E%3E-for-BufStream%3CRW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_stream.rs.html#87-119">source</a><a href="#impl-From%3CBufWriter%3CBufReader%3CRW%3E%3E%3E-for-BufStream%3CRW%3E" class="anchor"></a><h3 class="code-header">impl<RW> From<<a class="struct" href="struct.BufWriter.html" title="struct tokio::io::BufWriter">BufWriter</a><<a class="struct" href="struct.BufReader.html" title="struct tokio::io::BufReader">BufReader</a><RW>>> for <a class="struct" href="struct.BufStream.html" title="struct tokio::io::BufStream">BufStream</a><RW></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"><a class="srclink rightside" href="../../src/tokio/io/util/buf_stream.rs.html#88-118">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(b: <a class="struct" href="struct.BufWriter.html" title="struct tokio::io::BufWriter">BufWriter</a><<a class="struct" href="struct.BufReader.html" title="struct tokio::io::BufReader">BufReader</a><RW>>) -> Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><section id="impl-Unpin-for-BufWriter%3CW%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/io/util/buf_writer.rs.html#10-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 tokio::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 tokio::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 tokio::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 tokio::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 tokio::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-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-1" 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-1" 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="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
