Struct BufWriter

pub struct BufWriter<W> { /* private fields */ }

BufWriter is a struct with a buffer. BufWriter implements AsyncWriteRent, and if the inner io implements AsyncReadRent, it will delegate the implementation.

Implementations

impl<W> BufWriter<W>

pub fn new(inner: W) -> Self

Create BufWriter with default buffer size

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

Create BufWriter with given buffer size

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

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

Gets a mutable reference to the underlying writer.

pub fn into_inner(self) -> W

Consumes this BufWriter, returning the underlying writer.

Note that any leftover data in the internal buffer is lost.

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

Returns a reference to the internally buffered data.

Trait Implementations

impl<W: AsyncWriteRent + AsyncBufRead> AsyncBufRead for BufWriter<W>

fn fill_buf(&mut self) -> impl Future<Output = Result<&[u8]>>

Try read data and get a reference to the internal buffer

fn consume(&mut self, amt: usize)

Mark how much data is read

impl<W: AsyncWriteRent + AsyncReadRent> AsyncReadRent for BufWriter<W>

fn read<T: IoBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Reads bytes from this source into the provided buffer, returning the number of bytes read.

fn readv<T: IoVecBufMut>( &mut self, buf: T, ) -> impl Future<Output = BufResult<usize, T>>

Similar to read, but reads data into a slice of buffers.

impl<W: AsyncWriteRent> AsyncWriteRent for BufWriter<W>

async fn write<T: IoBuf>(&mut self, buf: T) -> BufResult<usize, T>

Writes the contents of a buffer into this writer, returning the number of bytes written.

async fn writev<T: IoVecBuf>(&mut self, buf: T) -> BufResult<usize, T>

This function attempts to write the entire contents of buf_vec, but the write may not fully succeed, and it might also result in an error. The bytes will be written starting at the specified offset.

async fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all buffered content is successfully written to its destination.

async fn shutdown(&mut self) -> Result<()>

Shuts down the output stream, ensuring that the value can be cleanly dropped.