Struct IndexingDecoderReader 

pub struct IndexingDecoderReader { /* private fields */ }

Owned decoded output that publishes a random-access index at verified EOF.

This reader has the same Read + Send behavior, runtime telemetry, dynamic worker controls, backpressure, and cancellation semantics as DecoderReader. Index construction is explicit in the type so the normal reader does not pay for checkpoint windows or lose the small, Copy DecodeReport result.

Reaching Read EOF means both the compressed stream and collected index have been validated. Self::report then borrows the complete result, while Self::finish consumes the reader and returns ownership of it.

Implementations

impl IndexingDecoderReader

pub fn handle(&self) -> DecoderHandle

Returns a cloneable telemetry and runtime-control handle.

pub fn stats(&self) -> DecoderStats

Returns an approximate lock-free snapshot of decoder activity.

pub fn set_worker_limit(&self, workers: usize) -> Result<(), WorkerLimitError>

Changes the maximum number of workers that may accept decoder tasks.

Errors

Returns WorkerLimitError for zero or a value above the configured worker budget.

pub const fn report(&self) -> Option<&IndexedDecodeReport>

Returns the indexed result after verified EOF has been observed.

This is None while decoding is open and after a terminal failure.

pub fn finish(self) -> Result<IndexedDecodeReport, IndexingError>

Discards unread output, verifies the remaining stream, finalizes the index, and returns both the scalar report and index.

Errors

Returns the first decoding, verification, input, worker, or index construction failure.

Trait Implementations

impl Read for IndexingDecoderReader

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

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<'_, u8>) -> 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<'_, u8>, ) -> 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.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.