Struct Id

pub struct Id<P: IsProtocol>(/* private fields */);

Represents a Controller Area Network (CAN) identifier of a specific protocol.

Implementations

impl Id<Can2A>

pub const fn id(self) -> u16

Returns the value of the identifier, which is truncated to 11-bits.

impl Id<Can2B>

pub const fn id(self) -> u32

Returns the value of the identifier, which is truncated to 29-bits.

impl Id<J1939>

pub const fn into_raw_parts(self) -> (u8, bool, bool, u8, u8, u8)

Decomposes the 29-bit J1939 identifier into its raw parts.

Returns a tuple containing the priority, reserved flag, data page flag, PDU format, PDU specific, and source address bits.

Examples

let id_a = IdJ1939::from_hex("00FF00FF");

let (p, r, dp, pf, ps, sa) = id_a.into_raw_parts();

pub fn from_raw_parts( priority: u8, reserved: bool, data_page: bool, pdu_format: u8, pdu_specific: u8, source_addr: u8, ) -> Result<Self, Error>

Constructs a 29-bit J1939 identifier from its raw parts.

Arguments

• priority: u8.
• reserved: bool.
• data_page: bool.
• pdu_format: u8.
• pdu_specific: u8.
• source_addr: u8.

Errors

• If priority value is invalid

Examples

let expected_id = IdJ1939::from_hex("00FF00FF");

let id_a = IdJ1939::from_raw_parts(0x0, false, false, 0xFF, 0x00, 0xFF);

assert_eq!(expected_id, id_a.unwrap());

pub const fn priority(&self) -> u8

Returns the priority bits indicating the priority level.

0 = highest priority

pub const fn reserved(&self) -> bool

Returns the reserved flag - 0 or 1

pub const fn data_page(&self) -> bool

Returns the data page flag - 0 or 1

pub const fn pdu_format(&self) -> u8

Returns the PDU format bits specifying the Protocol Data Unit format.

pub const fn pdu_specific(&self) -> u8

Returns the PDU specific bits providing additional details about the PDU.

pub fn source_address(&self) -> SourceAddr

Returns the source address bits identifying the source of the data.

impl Id<J1939>

pub const fn pgn_bits(&self) -> u32

Computes the PGN bitfield value based on the 29-bit identifier fields.

Returns

The combined PGN bitfield value.

pub const fn pgn(&self) -> Pgn

Constructs and returns a Pgn struct based on the 29-bit identifier fields.

Returns

A Pgn bitfield initialized with the 29-bit identifier fields.

Trait Implementations

impl<P: Clone + IsProtocol> Clone for Id<P>

fn clone(&self) -> Id<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + IsProtocol> Debug for Id<P>

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

Formats the value using the given formatter.

impl From<Id<Can2A>> for IdCan2B

fn from(value: IdCan2A) -> Self

Converts to this type from the input type.

impl<P: Ord + IsProtocol> Ord for Id<P>

fn cmp(&self, other: &Id<P>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<P: PartialEq + IsProtocol> PartialEq for Id<P>

fn eq(&self, other: &Id<P>) -> 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<P: PartialOrd + IsProtocol> PartialOrd for Id<P>

fn partial_cmp(&self, other: &Id<P>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<P: Copy + IsProtocol> Copy for Id<P>

impl<P: Eq + IsProtocol> Eq for Id<P>

impl<P: IsProtocol> StructuralPartialEq for Id<P>