Enum DecodeError 

#[non_exhaustive]
pub enum DecodeError {
    Io(Error),
    UnsupportedCodec(AudioCodec),
    UnsupportedContainer(ContainerFormat),
    InvalidData(String),
    SeekFailed(String),
    SeekOutOfRange(String),
    ProbeFailed,
    BackendUnavailable {
        backend: &'static str,
    },
    Interrupted,
    Backend(Box<dyn StdError + Send + Sync>),
}

Errors that can occur during audio decoding.

This error type is backend-agnostic, wrapping decoder-specific errors in the Backend variant.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io(Error)

UnsupportedCodec(AudioCodec)

UnsupportedContainer(ContainerFormat)

InvalidData(String)

SeekFailed(String)

SeekOutOfRange(String)

The seek target is invalid for this stream — past EOF, beyond the indexed sample range, or otherwise out of the addressable space.

Distinct from SeekFailed because there is no recovery action that helps: the duration/length come from the stream itself, not from decoder state, so a freshly built decoder rejects the same target with the same answer. Pipeline must surface this to the caller (fail the seek) rather than retry.

ProbeFailed

BackendUnavailable

The caller selected a backend that is not compiled in for the current target/feature combination (e.g. DecoderBackend::Apple on Linux, or DecoderBackend::Symphonia without the symphonia feature). Distinct from UnsupportedCodec (codec/container the backend cannot handle): BackendUnavailable means the backend itself is absent from the binary.

Fields

backend: &'static str

Interrupted

A seek interrupted the decode operation. Not a real error — the caller should check for pending seeks and retry.

Backend(Box<dyn StdError + Send + Sync>)

Implementations

impl DecodeError

pub fn backend<E>(err: E) -> Self

where E: Into<Box<dyn StdError + Send + Sync>>,

Wrap any StdError + Send + Sync payload as a DecodeError::Backend. Avoids 30+ repeats of .map_err(|e| DecodeError::Backend(Box::new(e))) across the apple / android / symphonia codec layers.

pub fn backend_msg<S>(msg: S) -> Self

where S: Into<String>,

Convenience constructor for “we have a description string, not a typed source error” — typically format!(...) payloads for FFI status codes (Apple OSStatus, Android media_status_t).

pub fn classify(&self) -> ErrorClass

Tag the error in one source-chain pass so hot decode loops can replace per-class boolean predicate ladders with a single match over the discriminant.

pub fn is_interrupted(&self) -> bool

Returns true if the error is an Interrupted variant.

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BudgetExhausted> for DecodeError

fn from(err: BudgetExhausted) -> Self

Converts to this type from the input type.

impl From<Error> for DecodeError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for DecodeError

fn from(err: TryFromIntError) -> Self

Converts to this type from the input type.