Struct SpillSource 

pub struct SpillSource { /* private fields */ }

A seekable source produced by draining a forward-only one.

Implementations

impl SpillSource

pub fn materialize(src: Box<dyn Source>, policy: &SpillPolicy) -> Result<Self>

Drains src into a seekable backing store, eagerly.

Eager rather than lazy: a container that asked for seek is about to read the trailing index, so it will need the whole stream regardless, and the eager path has no partially-materialized states to get wrong.

pub fn materialize_from<R: Read + ?Sized>( src: &mut R, policy: &SpillPolicy, ) -> Result<Self>

Self::materialize from any reader, borrowed: for a caller whose bytes are not a Source — an archive entry’s payload borrows its archive, so it can be neither boxed as 'static nor sent. stuffr convert buffers an entry of unknown size through this, under the same policy. The limits are SpillWriter’s, which this drives.

pub fn spilled_to_disk(&self) -> bool

Whether the spool escalated past the memory cap. Surfaced by stuffr info.

Trait Implementations

impl Debug for SpillSource

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

Formats the value using the given formatter.

impl Read for SpillSource

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 SpillSource

fn caps(&self) -> SourceCaps

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

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