Enum Error 

pub enum Error {
    Io(Error),
    Unsupported(String),
    InvalidData(String),
    Eof,
    NeedMore,
    FormatNotFound(String),
    CodecNotFound(String),
    ResourceExhausted(String),
    Other(String),
}

The error type shared by every oxideav crate. See the module docs for which variant to pick.

Variants

Io(Error)

An underlying transport / filesystem operation failed.

Unsupported(String)

Valid input exercising a feature this implementation lacks.

InvalidData(String)

The input violates its format’s rules; not retryable.

Eof

Logical end of stream (clean between packets; short otherwise).

NeedMore

Push-parser starvation: feed more bytes and call again.

FormatNotFound(String)

No registered container format matched the probe subject.

CodecNotFound(String)

No registered codec matched the requested name or tag.

ResourceExhausted(String)

A decoder (or arena pool) refused to allocate or proceed because doing so would exceed a configured DecoderLimits cap, or because a pool has no free slot. This is the canonical “DoS protection fired” error — callers should treat it as a hard rejection of the input or a transient backpressure signal, never retry blindly.

Other(String)

Anything that doesn’t fit the other variants; the message carries the whole story.

Implementations

impl Error

pub fn unsupported(msg: impl Into<String>) -> Self

Construct an Error::Unsupported with the given message.

pub fn invalid(msg: impl Into<String>) -> Self

Construct an Error::InvalidData with the given message.

pub fn other(msg: impl Into<String>) -> Self

Construct an Error::Other with the given message.

pub fn resource_exhausted(msg: impl Into<String>) -> Self

Construct a Error::ResourceExhausted with the given message. Use this from any decoder that has just hit a DecoderLimits cap or an arena-pool exhaustion.

pub fn format_not_found(msg: impl Into<String>) -> Self

Construct a Error::FormatNotFound with the given probe subject (file name, extension, or magic description).

pub fn codec_not_found(msg: impl Into<String>) -> Self

Construct a Error::CodecNotFound with the codec name or tag that missed the registry.

pub fn is_eof(&self) -> bool

true for Error::Eof. Error cannot implement PartialEq (the Io variant wraps std::io::Error), so drain loops that need “stop cleanly on end-of-stream” branch on this instead of a matches! at every call site.

pub fn is_need_more(&self) -> bool

true for Error::NeedMore — the push-parser “feed me more bytes and retry” signal.

pub fn is_resource_exhausted(&self) -> bool

true for Error::ResourceExhausted — the “DoS cap fired” signal that must not be blindly retried.

pub fn is_starved(&self) -> bool

true when the error only says the stream stopped short — Error::Eof or Error::NeedMore — rather than reporting malformed or unsupported content. Useful for probe loops that try successive parsers on a growing prefix: starvation means “inconclusive, buffer more”, anything else means “this parser has a verdict”.

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.