Struct bxcan::Frame

source ·
pub struct Frame { /* private fields */ }
Expand description

A CAN data or remote frame.

Implementations§

source§

impl Frame

source

pub fn new_data(id: impl Into<Id>, data: impl Into<Data>) -> Self

Creates a new data frame.

source

pub fn new_remote(id: impl Into<Id>, dlc: u8) -> Self

Creates a new remote frame with configurable data length code (DLC).

§Panics

This function will panic if dlc is not inside the valid range 0..=8.

source

pub fn is_extended(&self) -> bool

Returns true if this frame is an extended frame.

source

pub fn is_standard(&self) -> bool

Returns true if this frame is a standard frame.

source

pub fn is_remote_frame(&self) -> bool

Returns true if this frame is a remote frame.

source

pub fn is_data_frame(&self) -> bool

Returns true if this frame is a data frame.

source

pub fn id(&self) -> Id

Returns the frame identifier.

source

pub fn priority(&self) -> FramePriority

Returns the priority of this frame.

source

pub fn dlc(&self) -> u8

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.

source

pub fn data(&self) -> Option<&Data>

Returns the frame data (0..8 bytes in length) if this is a data frame.

If this is a remote frame, returns None.

Trait Implementations§

source§

impl Clone for Frame

source§

fn clone(&self) -> Frame

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Frame

source§

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

Formats the value using the given formatter. Read more
source§

impl Frame for Frame

source§

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

Creates a new frame. Read more
source§

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

Creates a new remote frame (RTR bit set). Read more
source§

fn is_extended(&self) -> bool

Returns true if this frame is a extended frame.
source§

fn is_remote_frame(&self) -> bool

Returns true if this frame is a remote frame.
source§

fn id(&self) -> Id

Returns the frame identifier.
source§

fn dlc(&self) -> usize

Returns the data length code (DLC) which is in the range 0..8. Read more
source§

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

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

fn is_standard(&self) -> bool

Returns true if this frame is a standard frame.
source§

fn is_data_frame(&self) -> bool

Returns true if this frame is a data frame.
source§

impl PartialEq for Frame

source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnwindSafe for Frame

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.