Struct bzip2::write::BzDecoder

[+] Show declaration

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

[−] Expand description

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

Methods

impl<W: Write> BzDecoder<W>[−]

Important traits for BzDecoder<W>

impl<W: Read + Write> Read for BzDecoder<W>impl<W: Write> Write for BzDecoder<W>

pub fn new(obj: W) -> BzDecoder<W>[−]

Create a new decoding stream which will decompress all data written to it into obj.

pub fn get_ref(&self) -> &W[−]

Acquires a reference to the underlying writer.

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

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

pub fn finish(&mut self) -> Result<W>[−]

Unwrap the underlying writer, finishing the compression stream.

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.

pub fn total_out(&self) -> u64[−]

Returns the number of bytes produced by the decompressor

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

pub fn total_in(&self) -> u64[−]

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

Trait Implementations

impl<W: Write> Drop for BzDecoder<W>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<W: Read + Write> Read for BzDecoder<W>[+]

[+] Show hidden undocumented items

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.

unsafe fn initializer(&self) -> Initializer[−]

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

Determines if this Reader can work with buffers of uninitialized memory.

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, appending them to 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 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.

impl<W: Write> Write for BzDecoder<W>[+]

[+] Show hidden undocumented items

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

Write a buffer into this writer, 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 writer.

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.