Struct Frame

pub struct Frame { /* private fields */ }

Frame with up to 8 bytes of data payload as per Classic(non-FD) CAN For CAN-FD support use FdFrame

Implementations

impl Frame

pub fn new( can_header: Header, raw_data: &[u8], ) -> Result<Self, FrameCreateError>

Create a new CAN classic Frame

pub fn new_data( id: impl Into<Id>, data: &[u8], ) -> Result<Self, FrameCreateError>

Creates a new data frame.

pub fn new_extended( raw_id: u32, raw_data: &[u8], ) -> Result<Self, FrameCreateError>

Create new extended frame

pub fn new_standard( raw_id: u16, raw_data: &[u8], ) -> Result<Self, FrameCreateError>

Create new standard frame

pub fn new_remote( id: impl Into<Id>, len: usize, ) -> Result<Self, FrameCreateError>

Create new remote frame

pub fn header(&self) -> &Header

Get reference to data

pub fn id(&self) -> &Id

Return ID

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

Get reference to data

pub fn priority(&self) -> u32

Get priority of frame

Trait Implementations

impl CanHeader for Frame

fn from_header(header: Header, data: &[u8]) -> Result<Self, FrameCreateError>

Construct frame from header and payload

fn header(&self) -> &Header

Get this frame’s header struct

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Format for Frame

where Header: Format, ClassicData: Format,

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

Writes the defmt representation of self to fmt.

impl Frame for Frame

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

Creates a new frame.

fn new_remote(id: impl Into<Id>, len: 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.

impl Copy for Frame