Enum DecodeError 

pub enum DecodeError {
    EmptyInput,
    BufferTooSmall {
        have: usize,
        want: usize,
    },
    ZeroMarker {
        at: usize,
    },
    ZeroBinary {
        at: usize,
    },
    ChunkOverflow {
        at: usize,
        marker: u8,
        len: usize,
    },
}

Error types that can be returned from decoding.

Variants

EmptyInput

The input is empty. A COBS stream is never shorter than one byte, since the empty payload encodes as a single 0x01.

BufferTooSmall

The output buffer holds have bytes but the worst case decoding of the input needs want, as computed by decode_buffer. Nothing was written. Inputs of a single byte skip this check, they never produce output.

Fields

have: usize

want: usize

ZeroMarker

The chunk marker at input offset at is zero, which no COBS stream contains. Both decode and decode_nonzero report it. The latter keeps this one check to stay memory safe.

Fields

at: usize

ZeroBinary

A chunk payload contains a zero byte at input offset at, which the encoder never produces. Only decode reports it. decode_nonzero trusts the caller and decodes such input to garbage instead.

Fields

at: usize

ChunkOverflow

The chunk marker at input offset at announces marker - 1 payload bytes, which run past the len bytes of input. Truncated frames end up here.

Fields

at: usize

marker: u8

len: usize

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, __formatter: &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