Enum StreamReadOutcome 

pub enum StreamReadOutcome {
    Bytes {
        count: NonZeroUsize,
        byte_position: u64,
    },
    Pending(PendingReason),
    Eof {
        byte_position: u64,
    },
}

Outcome of a Stream::try_read call.

Mirrors the ReadOutcome shape from Source::read_at, but extends each variant with the authoritative byte_position from the stream’s Timeline for callers that don’t want to read it back themselves. Bytes carries a NonZeroUsize count — the type system guarantees forward progress.

Variants

Bytes

Stream produced count bytes. byte_position is the new byte offset after the read.

Fields

count: NonZeroUsize

byte_position: u64

Pending(PendingReason)

No progress this call. See PendingReason for the precise cause and required caller action.

Eof

Natural end of stream. byte_position is the offset where EOF was observed (typically the source length).

Fields

byte_position: u64

Trait Implementations

impl Clone for StreamReadOutcome

fn clone(&self) -> StreamReadOutcome

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamReadOutcome

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

Formats the value using the given formatter.

impl PartialEq for StreamReadOutcome

fn eq(&self, other: &StreamReadOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StreamReadOutcome

impl Eq for StreamReadOutcome

impl StructuralPartialEq for StreamReadOutcome