Enum Error 

#[non_exhaustive]
pub enum Error {
    BadArg(&'static str),
    BufferTooSmall(&'static str),
    InvalidPacket(&'static str),
    Internal(&'static str),
}

Why an encoder, decoder, or packet operation failed.

The variants mirror libopus’ error codes (Error::code returns the libopus integer), and each carries a short static description of the specific condition. Display prints that description, so code that formatted the former &'static str errors produces identical text.

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.

BadArg(&'static str)

An argument was outside its valid range (libopus OPUS_BAD_ARG).

BufferTooSmall(&'static str)

The caller’s output buffer cannot hold the result (libopus OPUS_BUFFER_TOO_SMALL).

InvalidPacket(&'static str)

The input packet is malformed, truncated, or otherwise not valid Opus (libopus OPUS_INVALID_PACKET).

Internal(&'static str)

An internal codec stage failed (libopus OPUS_INTERNAL_ERROR).

Implementations

impl Error

pub const fn code(&self) -> i32

The equivalent libopus error code (always negative).

pub const fn message(&self) -> &'static str

The description of the specific condition.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Error

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

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error