Struct async_compression::tokio::write::buf_writer::BufWriter

pub struct BufWriter<W> {
    inner: W,
    buf: Box<[u8]>,
    written: usize,
    buffered: usize,
}

Fields

inner: W

buf: Box<[u8]>

written: usize

buffered: usize

Implementations

impl<W: AsyncWrite> BufWriter<W>

pub fn new(inner: W) -> Self

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

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

Creates a new BufWriter with the specified buffer capacity.

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

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

impl<W> BufWriter<W>

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.

It is inadvisable to directly write to the underlying writer.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut W>

Gets a pinned mutable reference to the underlying writer.

It is inadvisable to directly write 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.

Trait Implementations

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

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

Attempt to return an internal buffer to write to, flushing data out to the inner reader if it is full.

fn produce(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been written to its buffer, so they should be written out to the underlying IO when possible.

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

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

Attempt to write bytes from buf into the object.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

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

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

Formats the value using the given formatter.

impl<'__pin, W> Unpin for BufWriter<W>

where PinnedFieldsOf<__Origin<'__pin, W>>: Unpin,