Struct EspTwaiFrame 

pub struct EspTwaiFrame { /* private fields */ }

A RAM buffer for a TWAI frame.

Mirror image of the 13 TWAI_DATA_x_REG registers.

Implementations

impl EspTwaiFrame

pub fn is_remote_request(&self) -> bool

Remote Transmission Request (RTR): specifies whether content is a data frame or a remote request frame (on-demand polling).

Note: Remote request frames do not have a data payload, no matter their DLC.

pub fn is_self_reception(&self) -> bool

Self Reception (SR): indicates whether content was sent by us (using the TWAI_SELF_RX_SEQ command) or received from the bus.

pub fn data_length_code(&self) -> usize

Data Length Code (DLC): specifies the number of data bytes for a data frame, or the number of data bytes requested by a remote frame.

Note: although no frame can have a payload longer than 8, the DLC can be greater than 8 in rare cases (payload length then is still 8).

pub fn data_length(&self) -> usize

Length of the data payload: 0 for a RTR frame, 8 if DLC > 8.

pub fn identifier(&self) -> Id

Frame Identifier: 11-bit long for a SFF frame, 29-bit long for an EFF frame.

pub fn data(&self) -> &[u8]

Frame Data: data payload, 0 to 8 bytes long.

Returns a reference to a slice:

• empty in case of a Remote Transmission Request
• 8 bytes long in case DLC > 8

pub fn new(id: impl Into<Id>, data: &[u8]) -> Option<Self>

Create a new EspTwaiFrame with the specified ID and data payload.

pub fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self>

Create a new EspTwaiFrame for a transmission request with the specified ID and data length (DLC).

pub fn new_self_reception(id: impl Into<Id>, data: &[u8]) -> Option<Self>

Create a new EspTwaiFrame ready for self-reception with the specified ID and data payload.

Trait Implementations

impl Clone for EspTwaiFrame

Available on crate feature unstable only.

fn clone(&self) -> EspTwaiFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EspTwaiFrame

Available on crate feature unstable only.

impl Debug for EspTwaiFrame

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl Frame for EspTwaiFrame

Available on crate feature unstable only.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

fn new(id: impl Into<Id>, data: &[u8]) -> Option<Self>

Creates a new frame.

fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self>

Creates a new remote frame (RTR bit set).

fn is_extended(&self) -> bool

Returns true if this frame is a extended frame.

fn is_remote_frame(&self) -> bool

Returns true if this frame is a remote frame.

fn id(&self) -> Id

Returns the frame identifier.

fn dlc(&self) -> usize

Returns the data length code (DLC) which is in the range 0..8.

fn data(&self) -> &[u8]

Returns the frame data (0..8 bytes in length).

fn is_standard(&self) -> bool

Returns true if this frame is a standard frame.

fn is_data_frame(&self) -> bool

Returns true if this frame is a data frame.