Struct bzip2::write::BzEncoder

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

A compression stream which will have uncompressed data written to it and will write compressed data to an output stream.

Methods

impl<W: Write> BzEncoder<W>

fn new(obj: W, level: Compression) -> BzEncoder<W>

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

fn finish(self) -> Result<W>

Consumes this encoder, flushing the output stream.

This will flush the underlying data stream and then return the contained writer if the flush succeeded.

fn total_out(&self) -> u64

Returns the number of bytes produced by the compressor

Note that, due to buffering, this only bears any relation to total_in() after a call to flush(). At that point, total_out() / total_in() is the compression ratio.

fn total_in(&self) -> u64

Returns the number of bytes consumed by the compressor (e.g. the number of bytes written to this stream.)

Trait Implementations

impl<W: Write> Write for BzEncoder<W>

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

Write a buffer into this object, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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

impl<W: Write> Drop for BzEncoder<W>

fn drop(&mut self)

A method called when the value goes out of scope.