Enum babycat::Error

pub enum Error {
    FeatureNotCompiled(&'static str),
    WrongTimeOffset(u64, u64),
    WrongNumChannels(u32, u32),
    WrongNumChannelsAndMono,
    CannotZeroPadWithoutSpecifiedLength,
    UnknownInputEncoding,
    UnknownDecodeError,
    UnknownDecodeErrorWithMessage(&'static str),
    UnknownEncodeError,
    ResamplingError,
    ResamplingErrorWithMessage(&'static str),
    WrongFrameRate(u32, u32),
    WrongFrameRateRatio(u32, u32),
    FilenameIsADirectory(&'static str),
    FileNotFound(&'static str),
    UnknownIOError,
}

Variants

FeatureNotCompiled(&'static str)

Raised when you are trying to use a feature at runtime that was not included at compile-time.

For example, you may receive this error if you are trying to resample audio using a method that was not compiled for your target or binding.

WrongTimeOffset(u64, u64)

Raised when DecodeArgs.start_time_milliseconds or DecodeArgs.end_time_milliseconds is invalid.

For example, this error is raised if you set the end timestamp to be before the start timestamp.

WrongNumChannels(u32, u32)

Raised when you wanted to decode more channels than the audio actually had.

WrongNumChannelsAndMono

Raised if you specified DecodeArgs.convert_to_mono as true and DecodeArgs.num_channels as 1.

Setting both parameters is redundant and contradictory. You should either use DecodeArgs.convert_to_mono to flatten all channels or DecodeArgs.num_channels = 1 to select the first channel and discard the rest. You can set DecodeArgs.num_channels n > 1 and use DecodeArgs.convert_to_mono to only flatten those n channels. If you need to select channels in some other way, then do not provide either DecodeArgs.convert_to_mono or DecodeArgs.num_channels. All channels will be decoded and you can decide what to do with them.

CannotZeroPadWithoutSpecifiedLength

Raised if you set DecodeArgs.zero_pad_ending as true without also specifying DecodeArgs.end_time_milliseconds.

UnknownInputEncoding

Raised when we were not able to detect the encoded input as decodable audio.

UnknownDecodeError

Raised when we were not able to decode the given (encoded) audio.

UnknownDecodeErrorWithMessage(&'static str)

Raised when we were not able to decode the given (encoded) audio.

UnknownEncodeError

Raised when we encountered an unknown error when encoding a waveform into a particular format.

ResamplingError

Raised when we were not able to resample the audio.

ResamplingErrorWithMessage(&'static str)

WrongFrameRate(u32, u32)

Raised when we cannot resample from the input frame rate to the output frame rate.

WrongFrameRateRatio(u32, u32)

Raised if you are trying upsample or downsample audio by a factor greater than 256.

FilenameIsADirectory(&'static str)

Raised if you asked Babycat to read a file but gave it a path to a directory.

FileNotFound(&'static str)

Raised if you asked Babycat to read a file that does not exist.

UnknownIOError

Raised when something else went wrong while doing I/O.

Implementations

impl Error

pub fn error_type(&self) -> String

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Deserialize<'static> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'static>, 

Deserialize this value from the given Serde deserializer.

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)>

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()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Copy for Error

impl StructuralPartialEq for Error