Enum creek_core::read::error::ReadError

pub enum ReadError<FatalDecoderError: Error> {
    FatalError(FatalReadError<FatalDecoderError>),
    EndOfFile,
    CacheIndexOutOfRange {
        index: usize,
        num_caches: usize,
    },
    IOServerChannelFull,
    InvalidBuffer,
}

An error reading the file.

Variants

FatalError(FatalReadError<FatalDecoderError>)

A fatal error occured. The stream cannot continue.

Tuple Fields of FatalError

0: FatalReadError<FatalDecoderError>

EndOfFile

The end of the file was reached. The stream must be seeked to an earlier position to continue reading data. Until then, output silence.

If this is returned, then the playhead of the stream did not advance.

CacheIndexOutOfRange

The given cache with index index is out of range of the number of caches assigned to this stream. Please try a different index.

If this is returned, then the playhead of the stream did not advance.

Fields of CacheIndexOutOfRange

index: usizenum_caches: usize

IOServerChannelFull

The message channel to the IO server was full.

In theory this should not happen, but if it does, then output silence until the channel has more slots open later.

If this is returned, then the playhead of the stream did not advance.

InvalidBuffer

The given buffer does not match the internal layout of the stream. Check that the number of channels in both are the same.

If this is returned, then the playhead of the stream did not advance.

Trait Implementations

impl<FatalDecoderError: Debug + Error> Debug for ReadError<FatalDecoderError>

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

Formats the value using the given formatter.

impl<FatalDecoderError: Error> Display for ReadError<FatalDecoderError>

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

Formats the value using the given formatter.

impl<FatalDecoderError: Error> Error for ReadError<FatalDecoderError>

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