Struct CanFrame 

pub struct CanFrame {
    pub id: u32,
    /* private fields */
}

A CAN 2.0B frame with a 29-bit identifier and up to 8 data bytes.

CanFrame is a small Copy value (no heap allocation), the unit of exchange between this crate and your I/O layer. Convert to and from GridConnect text with gridconnect, or map to a SocketCAN / embedded CAN driver frame using CanFrame::id and CanFrame::data. Debug prints CanFrame(19490ABC [01 02]); Display and FromStr use GridConnect text (:X19490ABCN0102;, see gridconnect).

use rolcb::CanFrame;

let f = CanFrame::new(0x195B_4123, &[5, 1, 1, 1, 0x22, 0, 0, 0x10])?;
assert_eq!(f.data().len(), 8);
assert_eq!(f.src_alias(), 0x123);
assert!(CanFrame::new(0x195B_4123, &[0; 9]).is_err());

assert_eq!(f.to_string(), ":X195B4123N0501010122000010;");
assert_eq!(":X195B4123N0501010122000010;".parse::<CanFrame>()?, f);

Fields

id: u32

The 29-bit extended identifier (upper three bits always zero when built with CanFrame::new). Decode it with CanFrame::header.

Implementations

impl CanFrame

pub fn new(id: u32, data: &[u8]) -> Result<Self, ParseError>

Build a frame. id is masked to 29 bits.

Errors

ParseError::Length if data is longer than 8 bytes.

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

The data bytes (0 to 8).

pub fn header(&self) -> CanHeader

Decode the identifier into its OpenLCB meaning.

pub fn src_alias(&self) -> u16

The 12-bit source alias (bits 11-0 of the identifier). Present in every OpenLCB frame, control or message.

Trait Implementations

impl Clone for CanFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CanFrame

impl Debug for CanFrame

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

Formats the value using the given formatter.

impl Display for CanFrame

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

GridConnect text, e.g. :X19490ABCN0102; (no newline). Same as gridconnect::format.

impl Eq for CanFrame

impl FromStr for CanFrame

fn from_str(s: &str) -> Result<Self, ParseError>

Parse GridConnect text, as gridconnect::parse.

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for CanFrame

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CanFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CanFrame