Struct ClassicFrame 

pub struct ClassicFrame(/* private fields */);

A frame that is known to be classic CAN, for code written against embedded-can.

embedded_can::Frame promises at most 8 bytes of data, which a Frame cannot keep: a 64-byte FD frame is a Frame too. The trait is therefore implemented on this type, which the trait constructors build directly and which TryFrom<Frame> refuses to make from an FD frame.

The type dereferences to the Frame it wraps and converts back into one for CanFd::transmit.

Implementations

impl ClassicFrame

pub fn into_frame(self) -> Frame

Returns the frame this wraps.

Methods from Deref<Target = Frame>

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 ClassicFrame

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 ClassicFrame

Available on crate feature unstable only.

impl Debug for ClassicFrame

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl Deref for ClassicFrame

Available on crate feature unstable only.

type Target = Frame

The resulting type after dereferencing.

fn deref(&self) -> &Frame

Dereferences the value.

impl Frame for ClassicFrame

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.

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.