Struct bzip2::read::BzDecoder

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

A decompression stream which wraps a compressed stream of data. Decompressed data will be read from the stream.

Methods

impl<R: Read> BzDecoder<R>

Important traits for BzDecoder<R>

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

pub fn new(r: R) -> BzDecoder<R>

Create a new decompression stream, which will read compressed data from the given input stream and decompress it.

pub fn get_ref(&self) -> &R

Acquires a reference to the underlying stream

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

pub fn into_inner(self) -> R

Unwrap the underlying writer, finishing the compression stream.

pub fn total_out(&self) -> u64

Returns the number of bytes produced by the decompressor (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 decompressor reaches a sync point (e.g. where the original compressed stream was flushed). 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 read from the underlying stream)

Trait Implementations

impl<R: Read> Read for BzDecoder<R>

fn read(&mut self, into: &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 + Read> Write for BzDecoder<W>

fn write(&mut self, buf: &[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.