Enum ReadOutcome 

pub enum ReadOutcome {
    Frames {
        count: NonZeroUsize,
        position: Duration,
    },
    Pending {
        reason: PendingReason,
        position: Duration,
    },
    Eof {
        position: Duration,
    },
}

Result of a PCM read.

Each variant carries distinct caller semantics — the type system guarantees forward progress in Frames (via NonZeroUsize), while non-progress is explicit in Pending with a typed PendingReason. Failures surface as Err(DecodeError), never as an enum variant.

Variants

Frames

count frames were written into the output buffer (count > 0 by construction). position is the reader’s position after the read.

Fields

count: NonZeroUsize

position: Duration

Pending

Reader is alive but produced no frames this call. See PendingReason for the precise cause and required caller action. position is the reader’s current position (it has not advanced since the last successful read).

Fields

reason: PendingReason

position: Duration

Eof

Natural end of stream — the reader played up to duration(). No more frames will be produced. position is the final position (usually duration()).

Fields

position: Duration

Trait Implementations

impl Clone for ReadOutcome

fn clone(&self) -> ReadOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadOutcome

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

Formats the value using the given formatter.

impl PartialEq for ReadOutcome

fn eq(&self, other: &ReadOutcome) -> 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 ReadOutcome

impl Eq for ReadOutcome

impl StructuralPartialEq for ReadOutcome