Struct async_compression::futures::bufread::BzEncoder

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

This is supported on crate features futures-io and bzip2 only.

A bzip2 encoder, or compressor.

This structure implements an AsyncRead interface and will read uncompressed data from an underlying stream and emit a stream of compressed data.

Implementations

impl<R: AsyncBufRead> BzEncoder<R>

pub fn new(inner: R) -> Self

Creates a new encoder which will read uncompressed data from the given stream and emit a compressed stream.

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

Creates a new encoder which will read uncompressed data from the given stream and emit a compressed stream.

pub fn get_ref(&self) -> &R

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

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

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

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

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

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

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

pub fn into_inner(self) -> R

Consumes this encoder returning the underlying reader.

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<R: AsyncBufRead> AsyncRead for BzEncoder<R>

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

Attempt to read from the AsyncRead into buf.

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

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<R: Debug> Debug for BzEncoder<R>

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

Formats the value using the given formatter.

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