Struct async_std::io::BufWriter

source ·
pub struct BufWriter<W> { /* private fields */ }
Expand description

Wraps a writer and buffers its output.

It can be excessively inefficient to work directly with something that implements Write. For example, every call to write on TcpStream results in a system call. A BufWriter keeps an in-memory buffer of data and writes it to an underlying writer in large, infrequent batches.

BufWriter can improve the speed of programs that make small and repeated 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 Vec<u8>.

Unlike the BufWriter type in std, this type does not write out the contents of its buffer when it is dropped. Therefore, it is absolutely critical that users explicitly flush the buffer before dropping a BufWriter.

This type is an async version of std::io::BufWriter.

§Examples

Let’s write the numbers one through ten to a TcpStream:

use async_std::net::TcpStream;
use async_std::prelude::*;

let mut stream = TcpStream::connect("127.0.0.1:34254").await?;

for i in 0..10 {
    let arr = [i+1];
    stream.write(&arr).await?;
}

Because we’re not buffering, we write each one in turn, incurring the overhead of a system call per byte written. We can fix this with a BufWriter:

use async_std::io::BufWriter;
use async_std::net::TcpStream;
use async_std::prelude::*;

let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?);

for i in 0..10 {
    let arr = [i+1];
    stream.write(&arr).await?;
};

stream.flush().await?;

By wrapping the stream with a BufWriter, these ten writes are all grouped together by the buffer, and will all be written out in one system call when stream.flush() completes. (As mentioned above, dropping a BufWriter does not flush its buffers, so a flush call is essential.)

Implementations§

source§

impl<W: Write> BufWriter<W>

source

pub fn new(inner: W) -> BufWriter<W>

Creates a new BufWriter with a default buffer capacity. The default is currently 8 KB, but may change in the future.

§Examples
use async_std::io::BufWriter;
use async_std::net::TcpStream;

let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?);
source

pub fn with_capacity(capacity: usize, inner: W) -> BufWriter<W>

Creates a new BufWriter with the specified buffer capacity.

§Examples

Creating a buffer with a buffer of a hundred bytes.

use async_std::io::BufWriter;
use async_std::net::TcpStream;

let stream = TcpStream::connect("127.0.0.1:34254").await?;
let mut buffer = BufWriter::with_capacity(100, stream);
source

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

§Examples
use async_std::io::BufWriter;
use async_std::net::TcpStream;

let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?);

// We can use reference just like buffer
let reference = buffer.get_ref();
source

pub fn get_mut(&mut self) -> &mut W

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

§Examples
use async_std::io::BufWriter;
use async_std::net::TcpStream;

let mut buffer = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?);

// We can use reference just like buffer
let reference = buffer.get_mut();
source

pub async fn into_inner(self) -> Result<W, IntoInnerError<BufWriter<W>>>
where Self: Unpin,

Consumes BufWriter, returning the underlying writer

This method will not write leftover data, it will be lost. For method that will attempt to write before returning the writer see poll_into_inner

§Examples
use async_std::io::BufWriter;
use async_std::net::TcpStream;

let buf_writer = BufWriter::new(TcpStream::connect("127.0.0.1:34251").await?);

// unwrap the TcpStream and flush the buffer
let stream = buf_writer.into_inner().await.unwrap();
source

pub fn buffer(&self) -> &[u8]

Returns a reference to the internally buffered data.

§Examples
use async_std::io::BufWriter;
use async_std::net::TcpStream;

let buf_writer = BufWriter::new(TcpStream::connect("127.0.0.1:34251").await?);

// See how many bytes are currently buffered
let bytes_buffered = buf_writer.buffer().len();

Trait Implementations§

source§

impl<W: Write + Seek> AsyncSeek for BufWriter<W>

source§

fn poll_seek( self: Pin<&mut Self>, cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

Seek to the offset, in bytes, in the underlying writer.

Seeking always writes out the internal buffer before seeking.

source§

impl<W: Write> AsyncWrite for BufWriter<W>

source§

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object. Read more
source§

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
source§

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object. Read more
source§

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations. Read more
source§

impl<W: Write + Debug> Debug for BufWriter<W>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'__pin, W> Unpin for BufWriter<W>
where __Origin<'__pin, W>: Unpin,

Auto Trait Implementations§

§

impl<W> Freeze for BufWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for BufWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for BufWriter<W>
where W: Send,

§

impl<W> Sync for BufWriter<W>
where W: Sync,

§

impl<W> UnwindSafe for BufWriter<W>
where W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<S> AsyncSeekExt for S
where S: AsyncSeek + ?Sized,

source§

fn seek(&mut self, pos: SeekFrom) -> SeekFuture<'_, Self>
where Self: Unpin,

Seeks to a new position in a byte stream. Read more
source§

impl<W> AsyncWriteExt for W
where W: AsyncWrite + ?Sized,

source§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>
where Self: Unpin,

Writes some bytes into the byte stream. Read more
source§

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>], ) -> WriteVectoredFuture<'a, Self>
where Self: Unpin,

Like write(), except that it writes a slice of buffers. Read more
source§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>
where Self: Unpin,

Writes an entire buffer into the byte stream. Read more
source§

fn flush(&mut self) -> FlushFuture<'_, Self>
where Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more
source§

fn close(&mut self) -> CloseFuture<'_, Self>
where Self: Unpin,

Closes the writer. Read more
source§

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a>>
where Self: Sized + Send + 'a,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> SeekExt for T
where T: AsyncSeek + ?Sized,

source§

fn seek(&mut self, pos: SeekFrom) -> SeekFuture<'_, Self>
where Self: Unpin,

Seeks to a new position in a byte stream. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WriteExt for T
where T: AsyncWrite + ?Sized,

source§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>
where Self: Unpin,

Writes some bytes into the byte stream. Read more
source§

fn flush(&mut self) -> FlushFuture<'_, Self>
where Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more
source§

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>], ) -> WriteVectoredFuture<'a, Self>
where Self: Unpin,

Like write, except that it writes from a slice of buffers. Read more
source§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>
where Self: Unpin,

Writes an entire buffer into the byte stream. Read more
source§

fn write_fmt<'a>(&'a mut self, fmt: Arguments<'_>) -> WriteFmtFuture<'a, Self>
where Self: Unpin,

Writes a formatted string into this writer, returning any error encountered. Read more