Struct DecodeSideSource 

pub struct DecodeSideSource { /* private fields */ }

A Source whose read failures are marked as decode-side.

Wrapped around a codec’s decoder output by probe.rs — at both of the two places a decoder is built, so the marking is a property of “a decoder ran”, not of which resolution route was taken.

as_seek FORWARDS rather than wrapping, and that is a deliberate gap with a measured floor under it: a codec’s decoder returns StreamOnly, whose as_seek is None, so no seek reaches the forwarded path from any registered codec today. Wrapping it would need a second adapter around a borrowed &mut dyn SeekRead, which is not expressible without boxing per call. A codec that one day exposes a real seek table (seekable zstd, an xz block index — the case Source::as_seek exists for) must revisit this.

Implementations

impl DecodeSideSource

pub fn wrap(inner: Box<dyn Source>) -> Box<dyn Source>

Wraps inner, which must be a codec decoder’s output.

Returns a Box<dyn Source> rather than Self because every caller immediately needs the trait object, and handing back the concrete type would invite a caller to keep it and lose the marking by passing the inner source on instead.

Trait Implementations

impl Read for DecodeSideSource

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

impl Source for DecodeSideSource

fn caps(&self) -> SourceCaps

fn as_seek(&mut self) -> Option<&mut dyn SeekRead>

Returns a seekable view, or None if this source cannot seek.