impl<W: Write> BzEncoder<W>

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

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

fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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

Acquires a mutable reference to the underlying writer.

Note that mutating the output/input state of the stream may corrupt this object, so care must be taken when using this method.

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

Attempt to finish this output stream, writing out final chunks of data.

Note that this function can only be used once data has finished being written to the output stream. After this function is called then further calls to write may result in a panic.

Panics

Attempts to write data to this stream may result in a panic after this function is called.

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.

Note that this function may not be suitable to call in a situation where the underlying stream is an asynchronous I/O stream. To finish a stream the try_finish (or shutdown) method should be used instead. To re-acquire ownership of a stream it is safe to call this method after try_finish or shutdown has returned Ok.

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