Struct socketcan::frame::CanErrorFrame

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

A SocketCAN error frame.

This is returned from a read/receive by the OS or interface device driver when it detects an error, such as a problem on the bus. The frame encodes detailed information about the error, which can be managed directly by the application or converted into a Rust error

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

Implementations

impl CanErrorFrame

pub fn new_error( can_id: canid_t, data: &[u8] ) -> Result<Self, ConstructionError>

Creates a CAN error frame from raw parts.

Note that an application would not normally ever create an error frame. This is included mainly to aid in implementing mocks and other tests for an application.

The data byte slice should have the necessary codes for the supplied error. They will be zero padded to a full frame of 8 bytes.

Also note:

• The error flag is forced on
• The other, non-error, flags are forced off
• The frame data is always padded with zero’s to 8 bytes, regardless of the length of the data parameter provided.

pub fn error_bits(&self) -> u32

Return the error bits from the ID word of the error frame.

pub fn into_error(self) -> CanError

Converts this error frame into a CanError

Trait Implementations

impl AsPtr for CanErrorFrame

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 = can_frame

The inner type to which we resolve as a pointer

fn size(&self) -> usize

The size of the inner type

impl AsRef<can_frame> for CanErrorFrame

fn as_ref(&self) -> &can_frame

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

impl Clone for CanErrorFrame

fn clone(&self) -> CanErrorFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanErrorFrame

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

Formats the value using the given formatter.

impl Frame for CanErrorFrame

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 This does nothing on an error frame.

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

Sets the data payload of the frame. This is an error on an error 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 Frame for CanErrorFrame

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

Create an error frame.

Note that an application would not normally ever create an error frame. This is included mainly to aid in implementing mocks and other tests for an application.

This will set the error bit in the CAN ID word.

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

The application should not create an error frame. This will always return None.

fn is_extended(&self) -> bool

Check if frame uses 29-bit extended ID format.

fn is_remote_frame(&self) -> bool

Check if frame is a remote transmission request.

fn is_data_frame(&self) -> bool

Check if frame is a data frame.

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. An error frame can always acess the full 8-byte data payload.

fn is_standard(&self) -> bool

Returns true if this frame is a standard frame.

impl From<CanError> for CanErrorFrame

fn from(err: CanError) -> Self

Converts to this type from the input type.

impl From<CanErrorFrame> for CanError

fn from(frame: CanErrorFrame) -> Self

Constructs a CAN error from an error frame.

impl From<CanErrorFrame> for CanFrame

fn from(frame: CanErrorFrame) -> Self

Create a CanFrame from an error frame

impl From<CanErrorFrame> for Error

fn from(frame: CanErrorFrame) -> Self

Converts to this type from the input type.

impl TryFrom<can_frame> for CanErrorFrame

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

Try to create a CanErrorFrame from a C can_frame

This will only succeed the C frame is marked as an error frame.

type Error = ConstructionError

The type returned in the event of a conversion error.

impl UpperHex for CanErrorFrame

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

Formats the value using the given formatter.

impl Copy for CanErrorFrame