Struct ZstdStreamDecoder 

pub struct ZstdStreamDecoder<R: Read> { /* private fields */ }

Streaming Zstandard decoder that implements Read.

All compressed data is read eagerly from the inner reader on the first read call, decompressed into an internal buffer, and then served from that buffer for subsequent reads.

Supports optional progress reporting via ProgressHandle and cooperative cancellation via CancellationToken using the ZstdStreamDecoder::with_progress / ZstdStreamDecoder::with_cancel builders.

Implementations

impl<R: Read> ZstdStreamDecoder<R>

pub fn new(reader: R) -> Self

Create a new streaming decoder wrapping reader.

pub fn with_dictionary(reader: R, dict: Vec<u8>) -> Self

Create a new streaming decoder with a dictionary.

Dictionary-based decompression requires the same dictionary that was used during compression.

pub fn with_progress(self, handle: ProgressHandle) -> Self

Attach a progress sink.

The sink’s on_progress(decompressed_bytes, None) is called once after the entire stream is decompressed into the internal buffer. on_finish() is called at the same point.

pub fn with_cancel(self, token: CancellationToken) -> Self

Attach a cancellation token.

The token is checked before the compressed stream is read and decompressed. If cancelled, an I/O error wrapping oxiarc_core::error::OxiArcError::Cancelled is returned.

pub fn decompressed_size(&self) -> usize

Returns the total number of decompressed bytes available (including bytes already consumed via read).

pub fn is_finished(&self) -> bool

Returns true if all decompressed data has been read.

Trait Implementations

impl<R: Read> Read for ZstdStreamDecoder<R>

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

Read decompressed data into buf.

On the first call this eagerly decompresses the entire compressed stream from the inner reader. Subsequent calls serve from the buffer.

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_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.