Struct canadensis_can::Frame

pub struct Frame<I> { /* private fields */ }

CAN or CAN FD data frame with up to 64 bytes of data and an extended 29-bit ID

RTR/Error frames are not used and therefore not modeled here. CAN frames with 11-bit ID are not used by Cyphal/CAN and so they are not supported by the library.

Loopback

Each frame has a loopback flag.

For an outgoing frame, if loopback is true the driver should place a copy of this frame in the received frame path (as if it had been received on the bus) with the copy’s timestamp set to the time the frame was transmitted.

For an incoming frame, if loopback is true this frame was not actually received from another device. The frame timestamp is the time the original frame was sent.

This is useful for time synchronization.

Implementations

impl<I> Frame<I>

pub fn new(timestamp: I, id: CanId, data: &[u8]) -> Self

Creates a frame

The loopback flag is set to false.

Panics

This function will panic if the length of data is greater than FRAME_CAPACITY.

pub fn set_timestamp(&mut self, timestamp: I)

Sets the timestamp

pub fn set_loopback(&mut self, loopback: bool)

Sets the loopback flag

pub fn loopback(&self) -> bool

Returns the loopback flag

pub fn id(&self) -> CanId

Returns the ID of this frame

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

Returns the data in this frame

impl<I: Clone> Frame<I>

pub fn timestamp(&self) -> I

Returns the timestamp when this frame was received (for incoming frames) or the transmission deadline (for outgoing frames)

Trait Implementations

impl<I: Clone> Clone for Frame<I>

fn clone(&self) -> Frame<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for Frame<I>

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

Formats the value using the given formatter.

impl<I: Default> Default for Frame<I>

fn default() -> Frame<I>

Returns the “default value” for a type.

impl<I: PartialEq> PartialEq<Frame<I>> for Frame<I>

fn eq(&self, other: &Frame<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<I> StructuralPartialEq for Frame<I>