Enum CompressionDecoder

pub enum CompressionDecoder<'a> {
    Bzip2(BzDecoder<BufReader<File>>),
    Gzip(GzDecoder<BufReader<File>>),
    Xz(XzDecoder<BufReader<File>>),
    Zstd(Decoder<'a, BufReader<File>>),
}

Decoder for decompression which supports multiple backends.

Wraps BzDecoder, GzDecoder, XzDecoder and [Decoder] and provides a unified Read implementation across all of them.

Variants

Bzip2(BzDecoder<BufReader<File>>)

The bzip2 decompression decoder.

Gzip(GzDecoder<BufReader<File>>)

The gzip decompression decoder.

Xz(XzDecoder<BufReader<File>>)

The xz decompression decoder.

Zstd(Decoder<'a, BufReader<File>>)

The zstd decompression decoder.

Implementations

impl CompressionDecoder<'_>

pub fn new(file: File, algorithm: CompressionAlgorithm) -> Result<Self, Error>

Creates a new CompressionDecoder.

Uses a File to stream from and initializes a specific backend based on the provided CompressionAlgorithm.

Errors

Returns an error if creating the decoder for zstd compression fails (all other decoder initializations are infallible).

Trait Implementations

impl Debug for CompressionDecoder<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Read for CompressionDecoder<'_>

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>

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

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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