Struct bzip2::read::BzEncoder

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

A compression stream which wraps an uncompressed stream of data. Compressed data will be read from the stream.

Methods

impl<R: Read> BzEncoder<R>

fn new(r: R, level: Compression) -> BzEncoder<R>

Create a new compression stream which will compress at the given level to read compress output to the give output stream.

fn get_ref(&self) -> &R

Acquires a reference to the underlying stream

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

Acquires a mutable reference to the underlying stream

Note that mutation of the stream may result in surprising results if this encoder is continued to be used.

fn into_inner(self) -> R

Unwrap the underlying writer, finishing the compression stream.

fn total_out(&self) -> u64

Returns the number of bytes produced by the compressor (e.g. the number of bytes read from this stream)

Note that, due to buffering, this only bears any relation to total_in() when the compressor chooses to flush its data (unfortunately, this won't happen this won't happen in general at the end of the stream, because the compressor doesn't know if there's more data to come). At that point, total_out() / total_in() would be the compression ratio.

fn total_in(&self) -> u64

Returns the number of bytes consumed by the compressor (e.g. the number of bytes read from the underlying stream)

Trait Implementations

impl<R: Read> Read for BzEncoder<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.