Enum CodecError 

#[non_exhaustive]
pub enum CodecError {
    WrongFormat(String),
    Malformed(String),
    InvalidInput(String),
    Truncated {
        location: SourceLocation,
        operation: &'static str,
    },
    ResourceLimit(ResourceLimit),
    UnsupportedDialect {
        dialects: Box<DialectLayers>,
        message: String,
    },
    UnsupportedTarget(Box<TargetRefusal>),
    InsufficientDepth {
        format: &'static str,
        needed: DecodeDepth,
        recorded: DecodeDepth,
    },
    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.

operation: &'static str

Static operation that required the missing bytes.

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.

UnsupportedDialect

The document was identified, and its dialect is not supported.

Never reported as CodecError::WrongFormat: the bytes are this codec’s format, and the codec says so by carrying the identification it made. Identity survives refusal, so a caller can name what it was handed even though nothing was decoded.

The SAT codec constructs this variant for a recognized stream kind that does not frame. The STEP codec constructs it for the Part 26 HDF5, Part 28 XML, and AP242 business-object XML encodings that it identifies but does not decode.

The identification is boxed: it is the widest payload any variant of this enum carries, and every Result<_, CodecError> in the workspace would otherwise grow to its width.

Fields

dialects: Box<DialectLayers>

Every format layer identified before the refusal.

message: String

Why the identified dialect is not supported.

UnsupportedTarget(Box<TargetRefusal>)

The encoder could not resolve or deliver a write target.

InsufficientDepth

The document records less of its source than the encoder plans from.

Fields

format: &'static str

Output format of the refusing encoder.

needed: DecodeDepth

The least depth the encoder plans from.

recorded: DecodeDepth

The depth the document records.

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<DialectLayerError> for CodecError

fn from(error: DialectLayerError) -> Self

Converts to this type from the input type.

impl From<Error> for CodecError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<NamedEntryError> for CodecError

A source property whose key names nothing, or whose key the record already states, is an inconsistency inside the bytes that are present, so a reader that refuses the whole property set reports it as a malformed container.

fn from(refused: NamedEntryError) -> 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.

impl From<ResourceLimit> for CodecError

fn from(limit: ResourceLimit) -> Self

Converts to this type from the input type.

impl From<TargetRefusal> for CodecError

fn from(refusal: TargetRefusal) -> Self

Converts to this type from the input type.