Struct CanRemoteFrame

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

The classic CAN 2.0 remote request frame.

This is is meant to request a transmission by another node on the bus. It contain no data.

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

Implementations

impl CanRemoteFrame

pub fn set_dlc(&mut self, dlc: usize) -> Result<(), ConstructionError>

Sets the data length code for the frame

Trait Implementations

impl AsPtr for CanRemoteFrame

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

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

Gets a byte slice to the inner type

fn as_bytes_mut(&mut self) -> &[u8]

Gets a mutable byte slice to the inner type

impl AsRef<can_frame> for CanRemoteFrame

fn as_ref(&self) -> &can_frame

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

impl Clone for CanRemoteFrame

fn clone(&self) -> CanRemoteFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanRemoteFrame

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

Formats the value using the given formatter.

impl Default for CanRemoteFrame

fn default() -> Self

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

impl Frame for CanRemoteFrame

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

Create a new CAN 2.0 remote frame

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

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

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 CanRemoteFrame

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 will set the RTR flag in the CAN ID word.

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

Sets the data payload of the frame. For the Remote frame, this just updates the DLC to the length of the data slice.

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 can_id(&self) -> CanId

Return the CAN ID.

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<CanRemoteFrame> for CanAnyFrame

fn from(frame: CanRemoteFrame) -> Self

Converts to this type from the input type.

impl From<CanRemoteFrame> for CanFrame

fn from(frame: CanRemoteFrame) -> Self

Create a CanFrame from a remote frame

impl TryFrom<CanAnyFrame> for CanRemoteFrame

type Error = ConstructionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<CanFrame> for CanRemoteFrame

type Error = ConstructionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<can_frame> for CanRemoteFrame

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

Try to create a CanRemoteFrame from a C can_frame

This will only succeed the C frame is marked as a remote frame.

type Error = ConstructionError

The type returned in the event of a conversion error.

impl UpperHex for CanRemoteFrame

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

Formats the value using the given formatter.

impl Copy for CanRemoteFrame