Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidArgument(&'static str),
    #[non_exhaustive]
    BufferTooSmall {
        needed: usize,
        provided: usize,
    },
    InvalidPacket(&'static str),
    InvalidStream(&'static str),
    Io(Error),
    Internal(&'static str),
}

Anything that can go wrong encoding, decoding, or parsing an Opus stream.

The enum is #[non_exhaustive], so match with a _ arm: new variants are not a breaking change. The individual variants are not, deliberately — marking a tuple variant #[non_exhaustive] stops callers destructuring it at all, which would take away the message rather than protect it. BufferTooSmall is the exception, because a struct variant can be marked and still be matched with ...

Variants are grouped by who is at fault: Error::InvalidArgument and Error::BufferTooSmall mean the caller passed something the codec cannot honour, Error::InvalidPacket means the bitstream is malformed, and Error::Internal means a codec stage failed in a way that is not attributable to either.

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.

InvalidArgument(&'static str)

A configuration value is outside the range Opus allows — an unsupported sample rate or channel count, a frame size no coding mode can carry, or a mapping family that does not accept the requested layout.

#[non_exhaustive]

BufferTooSmall

The caller’s output slice cannot hold the result. Both sizes are in the unit of the call: bytes for encode, samples-per-channel for decode.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

needed: usize

What the operation needs.

provided: usize

What the caller provided.

InvalidPacket(&'static str)

The packet does not decode as Opus: a truncated or self-inconsistent frame-length field, an impossible frame count, padding that runs off the end, or a total duration above the 120 ms an Opus packet may carry.

InvalidStream(&'static str)

The Ogg container is malformed: a missing capture pattern, an unsupported page version, a CRC mismatch, or an OpusHead/OpusTags packet that does not match RFC 7845.

Io(Error)

The underlying reader or writer failed.

Internal(&'static str)

A codec stage failed. Reaching this from well-formed input is a bug in this crate; the string names the stage.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.