Enum lewton::header::HeaderReadError

pub enum HeaderReadError {
    EndOfPacket,
    NotVorbisHeader,
    UnsupportedVorbisVersion,
    HeaderBadFormat,
    HeaderBadType(u8),
    HeaderIsAudio,
    Utf8DecodeError,
    BufferNotAddressable,
}

Errors that can occur during Header decoding

Variants

EndOfPacket

NotVorbisHeader

If the passed data don't start with the "vorbis" capture pattern, this error is returned.

UnsupportedVorbisVersion

HeaderBadFormat

If the header violates the vorbis spec

HeaderBadType(u8)

The given packet indeed seems to be a vorbis header, but it looks like it is a different header type than the function it was passed to.

It is not guaranteed that the type is a valid header type.

HeaderIsAudio

The given packet does not seem to be a header as per vorbis spec, instead it seems to be an audio packet.

Utf8DecodeError

BufferNotAddressable

If the needed memory isn't addressable by us

This error is returned if a calculation yielded a higher value for an internal buffer size that doesn't fit into the platform's address range. Note that if we "simply" encounter an allocation failure (OOM, etc), we do what libstd does in these cases: crash.

This error is not automatically an error of the passed data, but rather is due to insufficient decoder hardware.

Trait Implementations

impl Debug for HeaderReadError

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

Formats the value using the given formatter.

impl Display for HeaderReadError

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for HeaderReadError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<()> for HeaderReadError

fn from(_: ()) -> HeaderReadError

Performs the conversion.

impl From<Error> for HeaderReadError

fn from(err: Error) -> HeaderReadError

Performs the conversion.

impl From<FromUtf8Error> for HeaderReadError

fn from(_: FromUtf8Error) -> HeaderReadError

Performs the conversion.

impl From<HeaderReadError> for VorbisError

fn from(err: HeaderReadError) -> VorbisError

Performs the conversion.

impl PartialEq<HeaderReadError> for HeaderReadError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for HeaderReadError