Struct CanFrame

#[repr(C)]
pub struct CanFrame { /* private fields */ }

CanFrame

Uses the same memory layout as the underlying kernel struct for performance reasons.

Implementations

impl CanFrame

pub fn new( id: u32, data: &[u8], rtr: bool, err: bool, ) -> Result<CanFrame, ConstructionError>

pub fn id(&self) -> u32

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

pub fn err(&self) -> u32

Return the error message

pub fn is_extended(&self) -> bool

Check if frame uses 29 bit extended frame format

pub fn is_error(&self) -> bool

Check if frame is an error message

pub fn is_rtr(&self) -> bool

Check if frame is a remote transmission request

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

A slice into the actual data. Slice will always be <= 8 bytes in length

pub fn error(&self) -> Result<CanError, CanErrorDecodingFailure>

Read error from message and transform it into a CanError.

SocketCAN errors are indicated using the error bit and coded inside id and data payload. Call error() converts these into usable CanError instances.

If the frame is malformed, this may fail with a CanErrorDecodingFailure.

Trait Implementations

impl Clone for CanFrame

fn clone(&self) -> CanFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanFrame

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

Formats the value using the given formatter.

impl UpperHex for CanFrame

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

Formats the value using the given formatter.

impl Copy for CanFrame