Enum CodecError 

#[non_exhaustive]
pub enum CodecError {
    WrongFormat(String),
    Malformed(String),
    InvalidInput(String),
    Truncated {
        location: SourceLocation,
        context: ErrorContext,
    },
    ResourceLimit(ResourceLimit),
    StrictRefusal {
        loss_code: String,
        message: String,
    },
    NotImplemented(String),
    Io(Error),
}

Errors a codec can raise.

Marked #[non_exhaustive]: external exhaustive matches must carry a wildcard arm.

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.

WrongFormat(String)

The bytes are not this codec’s format.

Malformed(String)

The container was structurally malformed.

InvalidInput(String)

The document supplied to an encoder violates its input contract.

Truncated

A required read extended past the end of its window after commitment.

Distinct from CodecError::Malformed: a truncation is missing input, not an inconsistency inside the bytes that are present.

Fields

location: SourceLocation

Where the truncated read began.

context: ErrorContext

Static context for the failure.

ResourceLimit(ResourceLimit)

A resource limit refused the decode: policy or the allocator.

Never reported as CodecError::Malformed: a budget refusal is a statement about policy, not about the input.

StrictRefusal

Strict decode mode refused a reported loss.

Never reported as CodecError::Malformed: a strict refusal is a statement about the decode mode, not about the input. The bytes can be well formed and still refuse under strict mode. The strict-mode gate in the Codec decode wrapper is the only construction site.

Fields

loss_code: String

Stable namespace/code form of the refusing loss.

message: String

The refusing loss’s own message, without any refusal prefix.

NotImplemented(String)

The codec does not implement a required capability.

Io(Error)

Underlying I/O failure.

Implementations

impl CodecError

pub fn malformed(message: impl Display) -> Self

Builds a malformed-container error from a displayable message.

pub const fn truncated( location: SourceLocation, operation: &'static str, ) -> Self

Builds a truncation error at a qualified source location.

Trait Implementations

impl Debug for CodecError

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

Formats the value using the given formatter.

impl Display for CodecError

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

Formats the value using the given formatter.

impl Error for CodecError

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 CodecError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for CodecError

fn from(error: ParseError) -> Self

Converts to this type from the input type.