Enum CoroutineError 

#[non_exhaustive]
pub enum CoroutineError {
    Storage(StorageError),
    InputRangeOverflow,
    InputSpanLimit {
        limit: usize,
    },
    Control(ControlError),
    RowAllocation,
    Source(SourceError),
    Sink(SinkError),
    Cancelled(StopReason),
    Finished,
    Stalled,
    RowsBeforeHeader,
    ReadExceedsInputCap {
        len: usize,
        cap: usize,
    },
}

Failure inside a coroutine decode, convertible into the codec’s error.

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.

Storage(StorageError)

Input payload, range index or row staging could not be admitted.

InputRangeOverflow

An absolute byte range overflowed the source address space.

InputSpanLimit

The admitted input range index cannot represent another disjoint span.

Fields

limit: usize

Maximum number of independently retained spans.

Control(ControlError)

A required interpretation boundary was violated.

RowAllocation

A row buffer size overflowed or its allocation failed.

Source(SourceError)

A read could not be satisfied (past the announced end).

Sink(SinkError)

The sink refused rows.

Cancelled(StopReason)

The driver’s stop token tripped.

Finished

The decoder was stepped after it finished or failed.

Stalled

The coroutine suspended without asking for anything (author bug).

RowsBeforeHeader

The coroutine wrote rows before setting the image info and output descriptor, so the sink could not be told the geometry (author bug).

ReadExceedsInputCap

One read asked for more bytes than the decoder’s input cap can hold, so it could never complete.

Fields

len: usize

Bytes the read needs.

cap: usize

The configured cap.

Trait Implementations

impl Debug for CoroutineError

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

Formats the value using the given formatter.

impl Display for CoroutineError

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

Formats the value using the given formatter.

impl Error for CoroutineError

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<Box<dyn Error + Send + Sync>> for CoroutineError

fn from(e: SinkError) -> Self

Converts to this type from the input type.

impl From<ControlError> for CoroutineError

fn from(error: ControlError) -> Self

Converts to this type from the input type.

impl From<SourceError> for CoroutineError

fn from(e: SourceError) -> Self

Converts to this type from the input type.

impl From<StopReason> for CoroutineError

fn from(r: StopReason) -> Self

Converts to this type from the input type.

impl From<StorageError> for CoroutineError

fn from(e: StorageError) -> Self

Converts to this type from the input type.