Struct async_compression::tokio::write::BzEncoder

pub struct BzEncoder<W> { /* fields omitted */ }

This is supported on crate features tokio and bzip2 only.

A bzip2 encoder, or compressor.

This structure implements an AsyncWrite interface and will take in uncompressed data and write it compressed to an underlying stream.

Implementations

impl<W: AsyncWrite> BzEncoder<W>

pub fn new(inner: W) -> Self

Creates a new encoder which will take in uncompressed data and write it compressed to the given stream.

pub fn with_quality(inner: W, level: Level) -> Self

Creates a new encoder which will take in uncompressed data and write it compressed to the given stream.

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer that this encoder is wrapping.

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

Acquires a mutable reference to the underlying writer that this encoder is wrapping.

Note that care must be taken to avoid tampering with the state of the writer which may otherwise confuse this encoder.

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

Acquires a pinned mutable reference to the underlying writer that this encoder is wrapping.

Note that care must be taken to avoid tampering with the state of the writer which may otherwise confuse this encoder.

pub fn into_inner(self) -> W

Consumes this encoder returning the underlying writer.

Note that this may discard internal state of this encoder, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<W: AsyncWrite> AsyncWrite for BzEncoder<W>

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

Attempt to write bytes from buf into the object.

pub 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.

pub 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.

pub 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.

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W: Debug> Debug for BzEncoder<W>

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

Formats the value using the given formatter.

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