Enum DecodeError 

pub enum DecodeError<SourceError, DestinationError> {
    Source(SourceError),
    Destination(DestinationError),
    UnexpectedSourceEof,
    EmptyFrame,
    InvalidFrame(DecodeProgress),
}

A failure to decode a frame.

Generic parameters preserve the source and destination error types. Match their variants to inspect them: the current core::error::Error implementation does not forward source().

Errors do not roll back partial output. Only InvalidFrame carries progress information.

Implementations such as Clone, Copy, serialization, and compact formatting depend on the corresponding traits being implemented by both generic error parameters.

Error formatting is diagnostic output, not a stable serialization format.

Variants

Source(SourceError)

Reading the source failed.

Never returned by the sync module, which reads from memory.

Destination(DestinationError)

The destination cannot hold the next decoded byte.

sync::decode_to_slice reports SeekableError::OutOfBounds here. The destination may be partially overwritten.

UnexpectedSourceEof

The input ended before the current COBS block was complete.

EmptyFrame

One-shot decoding reached EOF without starting an encoded frame.

Empty input and zero padding alone produce this error. A valid encoding of an empty payload, such as [1], does not.

InvalidFrame(DecodeProgress)

A zero delimiter arrived before the current COBS block had enough data.

Progress includes the delimiter and has frame_len: None. Partial output already written to the destination is not removed.

The next frame starts at source[progress.consumed as usize..].

Trait Implementations

impl<SourceError: Clone, DestinationError: Clone> Clone for DecodeError<SourceError, DestinationError>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<SourceError: Copy, DestinationError: Copy> Copy for DecodeError<SourceError, DestinationError>

impl<SourceError: Debug, DestinationError: Debug> Debug for DecodeError<SourceError, DestinationError>

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

Formats the value using the given formatter.

impl<'de, SourceError, DestinationError> Deserialize<'de> for DecodeError<SourceError, DestinationError>

where SourceError: Deserialize<'de>, DestinationError: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S, D> Display for DecodeError<S, D>

where S: Error, D: Error,

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

Formats the value using the given formatter.

impl<SourceError: Eq, DestinationError: Eq> Eq for DecodeError<SourceError, DestinationError>

impl<S: Error, D: Error> Error for DecodeError<S, D>

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<S, D> Format for DecodeError<S, D>

where D: Format, S: Format,

Available on crate feature defmt only.

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<SourceError: Hash, DestinationError: Hash> Hash for DecodeError<SourceError, DestinationError>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<SourceError: PartialEq, DestinationError: PartialEq> PartialEq for DecodeError<SourceError, DestinationError>

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

Equality operator ==.

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

Inequality operator !=.

impl<SourceError, DestinationError> Serialize for DecodeError<SourceError, DestinationError>

where SourceError: Serialize, DestinationError: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<SourceError: PartialEq, DestinationError: PartialEq> StructuralPartialEq for DecodeError<SourceError, DestinationError>