Enum Error

#[non_exhaustive]
pub enum Error {
    ReadError(OggReadError),
    NotOpus,
    MissingPacket,
    DataError(Error),
    MalformedComment(String),
    UTFError(FromUtf8Error),
    TooBigError,
    PictureError(PictureError),
    PlatformError(TryFromIntError),
}

Error type.

Encapsulates every error that could occur in the usage of this crate.

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.

ReadError(OggReadError)

Failed to read an ogg packet, or the file is not an ogg file

NotOpus

The selected file is an ogg file, but not an opus file.

MissingPacket

Expected a packet (for example, the comment header packet), but the stream ended early

DataError(Error)

An error occured while trying to execute an io operation. If the underlying ErrorKind is a ErrorKind::UnexpectedEof, then it usually means that a piece of data, either an ogg packet or an encoded image, was shorter than expected by the spec.

MalformedComment(String)

A comment was not in TAG=VALUE format. The offending line in the comment header is provided for convenience.

UTFError(FromUtf8Error)

Expected valid UTF-8 data as mandated by the spec, but did not receive it. The underlying FromUtf8Error provides the offending bytes for conveniece.

TooBigError

The content was too big for the opus spec (e.g. is more than u32::MAX bytes long). Since u32::MAX bytes is almost 4.3 GB, this error should almost never occur.

PictureError(PictureError)

An error occured while encoding or decoding a Picture. See PictureError for more info.

PlatformError(TryFromIntError)

Raised if the platform’s usize is smaller than 32 bits. This error is raised because the opus spec uses u32 for lengths, but Rust uses usize instead.

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, __formatter: &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(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<OggReadError> for Error

fn from(source: OggReadError) -> Self

Converts to this type from the input type.

impl From<PictureError> for Error

fn from(source: PictureError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(source: TryFromIntError) -> Self

Converts to this type from the input type.