Enum DecodeError 

pub enum DecodeError {
    UnexpectedEof {
        needed: usize,
        remaining: usize,
    },
    InvalidBool(u8),
    InvalidUtf8,
    LengthOverflow {
        length: usize,
        limit: usize,
    },
}

A byte stream that does not satisfy the Cyclone Specification.

The Specification (RFC-0002 §10) names the error conditions but not the way an implementation reports them. This runtime reports them as values.

Variant	Condition on the byte stream
UnexpectedEof	fewer bytes remain than the value requires
InvalidBool	a bool byte that is neither 0x00 nor 0x01
InvalidUtf8	a String byte region that is not valid UTF-8
LengthOverflow	a length/count field beyond the configured limit

InvalidEnum is deliberately absent: the set of valid values of an enum is schema knowledge, so validating it belongs to the generated codec, not to a runtime that knows nothing about schemas.

Variants

UnexpectedEof

Fewer bytes remain in the buffer than the value being read requires.

Fields

needed: usize

Number of bytes the read needed.

remaining: usize

Number of bytes actually left in the buffer.

InvalidBool(u8)

A bool was encoded as a byte other than 0x00 or 0x01.

A conforming decoder MUST NOT read this as “non-zero means true” (RFC-0002 §2.4). The offending byte is carried for diagnostics.

InvalidUtf8

The byte region of a String is not valid UTF-8 (RFC-0002 §3).

LengthOverflow

A length or count field exceeded the configured Limits.

This is the configurable, non-normative guard of RFC-0002 §12. The normative check - a length larger than the bytes actually remaining - surfaces as UnexpectedEof; both are applied, and both reject before any memory is allocated.

Fields

length: usize

The length or count read from the byte stream.

limit: usize

The configured limit it exceeded.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DecodeError

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Eq for DecodeError

impl Error for DecodeError

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 PartialEq for DecodeError

fn eq(&self, other: &DecodeError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DecodeError