Enum UnPackError 

pub enum UnPackError {
    ReSync {
        skip: usize,
    },
    MissingHeader {
        skip: usize,
    },
    UnexpectedEnd {
        read: usize,
    },
    InvalidChecksum {
        at: usize,
    },
    MarshalerError(MarshalerError),
}

Errors returned by Messager::unpack and Messager::unmarshal.

Variants

ReSync

The input does not start with the SOF byte (0xA5), but a SOF byte was found later in the buffer.

skip is the byte offset of the first SOF byte found. Discard that many bytes from the input, then retry.

Fields

skip: usize

The byte offset of the first SOF byte found in the input buffer.

MissingHeader

No SOF byte was found anywhere in the input buffer.

skip equals the buffer length. Discard the entire buffer and wait for more data before retrying.

Fields

skip: usize

The length of the input buffer, which should be discarded.

UnexpectedEnd

The frame is truncated; more bytes are needed to complete it.

read is the number of bytes currently available. Keep the existing bytes and wait for more data before retrying.

Fields

read: usize

The number of bytes currently available in the input buffer.

InvalidChecksum

CRC validation failed (header CRC8 or frame CRC16).

at is the cursor position when the failure was detected. Call UnPackError::skip to determine how many bytes to discard.

Fields

at: usize

The cursor position in the input buffer where the checksum failure was detected.

MarshalerError(MarshalerError)

The payload could not be decoded into the target type.

Wraps a MarshalerError from RawFrame::unmarshal.

Implementations

impl UnPackError

pub fn skip(&self) -> usize

Returns the number of bytes to discard before retrying a parse.

Use this when processing a continuous byte stream to advance the read position past invalid or incomplete data:

Variant	Returned value	Action
ReSync	offset of next SOF	discard bytes, retry
MissingHeader	buffer length	discard all, wait for data
UnexpectedEnd	0	wait for more data at current position
InvalidChecksum	cursor at failure	discard frame, retry
MarshalerError	0	frame was consumed; handle decode error

Trait Implementations

impl Debug for UnPackError

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

Formats the value using the given formatter.

impl Display for UnPackError

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

Formats the value using the given formatter.

impl Error for UnPackError

fn source(&self) -> Option<&(dyn StdError + '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 Format for UnPackError

where MarshalerError: Format,

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

Writes the defmt representation of self to fmt.

impl From<MarshalerError> for UnPackError

fn from(err: MarshalerError) -> Self

Converts to this type from the input type.