Enum DeviceMessage 

pub enum DeviceMessage {
    Ok(OkPayload),
    Err(ErrorCode),
    Rx(RxPayload),
    TxDone(TxDonePayload),
}

Any device→host message, parsed into its semantic form.

Variants

Ok(OkPayload)

Err(ErrorCode)

Rx(RxPayload)

TxDone(TxDonePayload)

Implementations

impl DeviceMessage

pub const fn type_id(&self) -> u8

pub fn encode_payload( &self, buf: &mut [u8], ) -> Result<usize, DeviceMessageEncodeError>

Encode the device-message payload (bytes between frame header and CRC) into buf. Returns the number of bytes written.

pub fn parse( type_id: u8, payload: &[u8], originating_cmd_type: Option<u8>, ) -> Result<Self, DeviceMessageParseError>

Parse a (type_id, payload) pair.

originating_cmd_type MUST be supplied for OK frames: it is the type_id of the H→D command whose tag the host observed echoed back. For all other device-message types it is ignored (pass None).

Trait Implementations

impl Clone for DeviceMessage

fn clone(&self) -> DeviceMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceMessage

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

Formats the value using the given formatter.

impl Format for DeviceMessage

where OkPayload: Format, ErrorCode: Format, RxPayload: Format, TxDonePayload: Format,

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

Writes the defmt representation of self to fmt.

impl PartialEq for DeviceMessage

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DeviceMessage

impl StructuralPartialEq for DeviceMessage