Struct CanId 

pub struct CanId { /* private fields */ }

A CAN arbitration identifier.

CAN comes in two identifier widths: the original standard 11-bit form and the extended 29-bit form that higher-layer protocols such as J1939 use to pack a priority, a parameter group, and addresses into the ID itself. This type holds either, always masked to its width.

Examples

use pamoja_can::CanId;

let std = CanId::standard(0x123);
assert!(!std.is_extended());
assert_eq!(std.raw(), 0x123);

// Values wider than the identifier are masked to fit.
assert_eq!(CanId::standard(0xFFFF).raw(), 0x7FF);

Implementations

impl CanId

pub const STANDARD_MASK: u32 = 0x7FF

The mask of a standard 11-bit identifier.

pub const EXTENDED_MASK: u32 = 0x1FFF_FFFF

The mask of an extended 29-bit identifier.

pub fn standard(raw: u16) -> CanId

Creates a standard 11-bit identifier, masking the value to fit.

Arguments

• raw - the identifier value; bits above the low 11 are dropped.

Returns

The identifier.

pub fn extended(raw: u32) -> CanId

Creates an extended 29-bit identifier, masking the value to fit.

Arguments

• raw - the identifier value; bits above the low 29 are dropped.

Returns

The identifier.

pub fn raw(&self) -> u32

Returns the identifier value.

Returns

The raw bits, already masked to the identifier’s width.

pub fn is_extended(&self) -> bool

Reports whether this is an extended 29-bit identifier.

Returns

true for an extended identifier, false for a standard one.

Trait Implementations

impl Clone for CanId

fn clone(&self) -> CanId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CanId

impl Debug for CanId

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

Formats the value using the given formatter.

impl Eq for CanId

impl PartialEq for CanId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CanId