Trait Frame 

pub trait Frame: Sized {
    // Required methods
    fn new(id: impl Into<Id>, data: &[u8]) -> Option<Self>;
    fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self>;
    fn is_extended(&self) -> bool;
    fn is_remote_frame(&self) -> bool;
    fn id(&self) -> Id;
    fn dlc(&self) -> usize;
    fn data(&self) -> &[u8] ;

    // Provided methods
    fn is_standard(&self) -> bool { ... }
    fn is_data_frame(&self) -> bool { ... }
}

A CAN2.0 Frame

Required Methods

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

Creates a new frame.

This will return None if the data slice is too long.

fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self>

Creates a new remote frame (RTR bit set).

This will return None if the data length code (DLC) is not valid.

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.

For data frames the DLC value always matches the length of the data. Remote frames do not carry any data, yet the DLC can be greater than 0.

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

Returns the frame data (0..8 bytes in length).

Provided Methods

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.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Frame for CanAnyFrame

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

Create a new CAN frame If the data

fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<CanAnyFrame>

Create a new remote transmission request frame.

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 id(&self) -> Id

Return the frame identifier.

fn dlc(&self) -> usize

Data length

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

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

impl Frame for CanFrame

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

Create a new CAN 2.0 data frame

fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<CanFrame>

Create a new remote transmission request frame.

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 id(&self) -> Id

Return the frame identifier.

fn dlc(&self) -> usize

Data length

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

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

impl Frame for CanDataFrame

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

Create a new CAN 2.0 data frame

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

Create a new remote transmission request frame.

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 id(&self) -> Id

Return the frame identifier.

fn dlc(&self) -> usize

Data length

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

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

impl Frame for CanErrorFrame

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

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<CanErrorFrame>

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 access the full 8-byte data payload.

impl Frame for CanFdFrame

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

Create a new FD frame

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

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.

This should only be one of the valid CAN FD data lengths.

impl Frame for CanRemoteFrame

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

Create a new CAN 2.0 remote frame

fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<CanRemoteFrame>

Create a new remote transmission request frame.

This will set the RTR flag in the CAN ID word.

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 id(&self) -> Id

Return the frame identifier.

fn dlc(&self) -> usize

Data length code

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

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

Implementors

impl Frame for host_can::frame::CanFrame