Struct SourceReader 

pub struct SourceReader { /* private fields */ }

Supplies bytes to the receiver as either a sequential or seekable stream.

Use Self::streaming for Read-only sources, Self::seekable for Read + Seek sources, or Self::spooled (feature spool) to materialize a source into temporary storage.

The selected reader kind determines whether IStream::Seek can succeed and whether the stream size can be derived when not explicitly provided.

Implementations

impl SourceReader

pub fn streaming<R>(reader: R) -> Self

where R: Read + Send + 'static,

Wraps a sequential Read source without materializing its contents.

The reader does not support seeking, and its length cannot be derived. Supply a size using crate::VirtualFile::with_size when the receiving application requires one.

pub fn seekable<R>(reader: R) -> Self

where R: Read + Seek + Send + 'static,

Wraps a Read + Seek source that supports random access.

When a file size is not provided, the length can be derived by seeking to the end and restoring the original position. The underlying reader must support those operations reliably.

pub fn spooled<R>(reader: R) -> Result<Self>

where R: Read + Send + 'static,

Copies the complete source into a temporary file and returns a seekable reader backed by that file.

Spooling is explicit and finishes before this method returns. It trades temporary disk usage and startup latency for seekability and a derivable size. The temporary file’s lifetime is managed with the returned reader.

Requires the spool feature.

Errors

Returns an I/O error if creating, writing, seeking, or reading the temporary file or source fails.

Trait Implementations

impl Read for SourceReader

fn read(&mut self, buffer: &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.