Enum DecodeEvent 

pub enum DecodeEvent<'a> {
    NeedMore,
    Frame {
        frame: Frame<'a>,
        consumed: usize,
    },
    Invalid {
        discard: usize,
    },
    Malformed {
        discard: usize,
        error: FrameError,
        destination: Option<u8>,
    },
    Error(FrameError),
}

The outcome of one StreamDecoder::push_slice call.

Variants

NeedMore

Nothing complete and nothing to discard: push more octets.

Frame

A valid frame. It borrows the decoder’s storage and stays buffered until the next push, which removes it.

Fields

frame: Frame<'a>

The decoded frame.

consumed: usize

The frame’s wire length.

Invalid

Line noise was discarded while searching for a preamble: every buffered octet up to the next 0x55 among them, which might start one, in a single event. A run of noise that arrives over several pushes gives one event per push.

This is not a received invalid frame in terms of the Clause 9.5.4 receive state machine.

Fields

discard: usize

Octets discarded.

Malformed

A candidate frame failed a check and was dropped.

Fields

discard: usize

Octets of the stream discarded, counted from the candidate’s first octet.

When its header passed every check, its declared length can be trusted, so the decoder drops the whole frame by count, as the receive state machine skips one (Clause 9.5.4.4): for a frame longer than the storage, a reserved COBS type, or data that failed its CRC. This is then the frame’s wire length, and any of it that hasn’t arrived yet is dropped as it comes, with no further event. For anything else, a bad header or one that never completes, it is the first preamble octet, and the octets after it are scanned again.

error: FrameError

Why the candidate was dropped.

destination: Option<u8>

The candidate’s destination address once its header CRC has passed, including for a header refused afterwards (source 255, a Length out of range). None when the header CRC failed or the header never completed. See StreamDecoder for why a receiver needs it.

Error(FrameError)

The pushed slice did not fit in the free storage. None of it was taken; see StreamDecoder.

Trait Implementations

impl<'a> Clone for DecodeEvent<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DecodeEvent<'a>

impl<'a> Debug for DecodeEvent<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for DecodeEvent<'a>

impl<'a> PartialEq for DecodeEvent<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DecodeEvent<'a>