Struct Frame 

pub struct Frame { /* private fields */ }

A CAN FD frame.

Implementations

impl Frame

pub fn new(id: impl Into<Id>, payload: &[u8]) -> Result<Self, FrameError>

Creates a new classic CAN data frame.

Errors

FrameError::PayloadTooLong when payload is longer than 8 bytes.

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

Creates a new classic CAN request frame.

A request frame carries no payload. len is the payload length that the frame asks for.

Errors

FrameError::PayloadTooLong when len is greater than 8.

pub fn new_fd(id: impl Into<Id>, payload: &[u8]) -> Result<Self, FrameError>

Creates a new CAN FD data frame.

The data phase uses the nominal bit rate unless Frame::with_bit_rate_switch is set.

Errors

FrameError::PayloadTooLong when payload is longer than 64 bytes.

pub fn with_bit_rate_switch(self, bit_rate_switch: bool) -> Self

Sets whether the data phase is sent at the FD bit rate.

Only a CAN FD frame can switch bit rate; the setting is ignored on a classic frame.

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

Returns the payload the frame carries.

pub fn len(&self) -> usize

Returns the payload length in bytes.

pub fn is_empty(&self) -> bool

Returns whether the frame carries no payload.

pub fn requested_len(&self) -> usize

Returns the payload length a request frame asks for, in bytes.

Zero for a data frame, whose length is Frame::len.

pub fn dlc(&self) -> u8

Returns the data length code the frame is sent with.

A payload length that no code expresses is padded up to the next one, so a received copy of the frame can be longer than Frame::len.

pub fn id(&self) -> Id

Returns the arbitration identifier.

pub fn is_extended(&self) -> bool

Returns whether the identifier is a 29-bit extended one.

pub fn is_request(&self) -> bool

Returns whether this is a request frame, which carries no payload.

pub fn is_fd(&self) -> bool

Returns whether the frame uses the CAN FD format.

pub fn is_bit_rate_switched(&self) -> bool

Returns whether the data phase uses the FD bit rate.

pub fn error_state_indicator(&self) -> bool

Returns the error state indicator of the transmitting node.

pub fn timestamp(&self) -> u64

Returns the timestamp captured when the frame was received.

Zero for a frame that was not received; see CanFd::start_timestamp_timer.

Trait Implementations

impl Clone for Frame

Available on crate feature unstable only.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame

Available on crate feature unstable only.

impl Debug for Frame

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl From<ClassicFrame> for Frame

Available on crate feature unstable only.

fn from(frame: ClassicFrame) -> Self

Converts to this type from the input type.

impl TryFrom<Frame> for ClassicFrame

Available on crate feature unstable only.

fn try_from(frame: Frame) -> Result<Self, FrameError>

Errors

FrameError::NotClassic when the frame uses the CAN FD format.

type Error = FrameError

The type returned in the event of a conversion error.