Struct ReadCursor 

pub struct ReadCursor { /* private fields */ }

Drives a stage over a sequential stream.

The cursor owns one window over the stream. It reads read_size bytes at a time (more when a request needs a larger contiguous span, up to max_window), offers the window, and drops what the stage took. Bytes the stage skips ahead over are read and discarded; a request behind the stream position is PumpFailure::NeedsRandomAccess.

Implementations

impl ReadCursor

pub fn new(read_size: usize, max_window: usize) -> Self

A cursor reading read_size bytes at a time (at least 512) and holding at most max_window contiguous bytes for one request.

pub fn retained_input_capacity(&self) -> usize

Retained input allocation capacity, excluding the reader’s own buffers.

pub fn next<S, R>( &mut self, reader: &mut R, stage: &mut S, pulse: Option<&dyn Pulse>, ) -> Result<Yield<S::Output>, PumpFailure<S::Error>>

where S: ByteStepper + ?Sized, R: Read + ?Sized,

Step stage over reader until it produces an output. Pass the same reader on every call.

Trait Implementations

impl Debug for ReadCursor

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

Formats the value using the given formatter.