Struct socketcan::frame::CanFdFrame

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

The CAN flexible data rate frame with up to 64-bytes of data.

This is highly compatible with the canfd_frame from libc. (ref)

Implementations

impl CanFdFrame

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

Create a new FD frame with FD flags

pub fn flags(&self) -> FdFlags

Gets the flags for the FD frame.

These are the bits from the separate FD frame flags, not the flags in the composite ID word.

pub fn is_brs(&self) -> bool

Whether the frame uses a bit rate switch (second bit rate for payload data).

pub fn set_brs(&mut self, on: bool)

Sets whether the frame uses a bit rate switch.

pub fn is_esi(&self) -> bool

Gets the error state indicator of the transmitting node

pub fn set_esi(&mut self, on: bool)

Sets the error state indicator of the transmitting node

Trait Implementations

impl AsPtr for CanFdFrame

fn as_ptr(&self) -> *const Self::Inner

Gets a pointer to the CAN frame structure that is compatible with the Linux C API.

fn as_mut_ptr(&mut self) -> *mut Self::Inner

Gets a mutable pointer to the CAN frame structure that is compatible with the Linux C API.

type Inner = canfd_frame

The inner type to which we resolve as a pointer

fn size(&self) -> usize

The size of the inner type

impl AsRef<canfd_frame> for CanFdFrame

fn as_ref(&self) -> &canfd_frame

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CanFdFrame

fn clone(&self) -> CanFdFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanFdFrame

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

Formats the value using the given formatter.

impl Default for CanFdFrame

fn default() -> Self

The default FD frame has all fields and data set to zero, and all flags off.

impl Frame for CanFdFrame

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

Create a new FD frame

fn new_remote(_id: impl Into<Id>, _dlc: usize) -> Option<Self>

CAN FD frames don’t support remote

fn is_extended(&self) -> bool

Check if frame uses 29-bit extended ID format.

fn is_remote_frame(&self) -> bool

The FD frames don’t support remote request

fn id(&self) -> Id

Return the frame identifier.

fn dlc(&self) -> usize

Data length code

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

A slice into the actual data.

For normal CAN frames the slice will always be <= 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 Frame for CanFdFrame

fn id_word(&self) -> canid_t

Get the composite SocketCAN ID word, with EFF/RTR/ERR flags

fn set_id(&mut self, id: impl Into<Id>)

Sets the CAN ID for the frame

fn set_data(&mut self, data: &[u8]) -> Result<(), ConstructionError>

Sets the data payload of the frame.

fn from_raw_id(id: u32, data: &[u8]) -> Option<Self>

Creates a frame using a raw, integer CAN ID.

fn remote_from_raw_id(id: u32, dlc: usize) -> Option<Self>

Creates a remote frame using a raw, integer CAN ID.

fn raw_id(&self) -> canid_t

Return the actual raw CAN ID (without EFF/RTR/ERR flags)

fn id_flags(&self) -> IdFlags

Returns the EFF/RTR/ERR flags from the ID word

fn hal_id(&self) -> Id

Return the CAN ID as the embedded HAL Id type.

fn len(&self) -> usize

Get the data length

fn is_error_frame(&self) -> bool

Check if frame is an error message

impl From<CanDataFrame> for CanFdFrame

fn from(frame: CanDataFrame) -> Self

Converts to this type from the input type.

impl From<CanFdFrame> for CanAnyFrame

fn from(frame: CanFdFrame) -> Self

Converts to this type from the input type.

impl From<canfd_frame> for CanFdFrame

fn from(frame: canfd_frame) -> Self

Converts to this type from the input type.

impl TryFrom<CanFdFrame> for CanDataFrame

type Error = ConstructionError

The type returned in the event of a conversion error.

fn try_from(frame: CanFdFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CanFdFrame> for CanFrame

fn try_from( frame: CanFdFrame ) -> Result<Self, <Self as TryFrom<CanFdFrame>>::Error>

Try to convert a CAN FD frame into a classic CAN 2.0 frame.

This should work if it’s a data frame with 8 or fewer data bytes.

type Error = ConstructionError

The type returned in the event of a conversion error.

impl UpperHex for CanFdFrame

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

Formats the value using the given formatter.

impl Copy for CanFdFrame