Struct can_type_rs::j1939::Pgn

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

Bitfield representation of 18-bit Parameter Group Number (PGN).

Repr: u32

Field	Size (bits)
Padding bits (private)	14
Reserved bits	1
Data page bits	1
PDU format bits	8
PDU specific bits	8

Implementations

impl Pgn

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u32) -> Self

Convert from bits.

pub const fn into_bits(self) -> u32

Convert into bits.

impl Pgn

pub const fn pdu_format(&self) -> PduFormat

Returns the PDU format based on the parsed bits.

Returns

• PduFormat::Pdu1(bits) if the PDU format value is less than 240.
• PduFormat::Pdu2(bits) otherwise.

pub const fn group_extension(&self) -> GroupExtension

Returns the group extension based on the parsed bits.

Returns

• GroupExtension::None if the PDU format is Pdu1.
• GroupExtension::Some(bits) if the PDU format is Pdu2.

pub const fn destination_address(&self) -> DestinationAddress

Returns the destination address based on the parsed PDU format.

Returns

• DestinationAddress::Some(bits) if the PDU format is Pdu1.
• DestinationAddress::None if the PDU format is Pdu2.

pub const fn communication_mode(&self) -> CommunicationMode

Returns the communication mode based on the parsed PDU format.

Returns

• CommunicationMode::P2P if the PDU format is Pdu1.
• CommunicationMode::Broadcast if the PDU format is Pdu2.

pub const fn is_p2p(&self) -> bool

Checks if the communication mode is point-to-point (P2P).

Returns

• true if the communication mode is P2P.
• false if the communication mode is Broadcast.

pub const fn is_broadcast(&self) -> bool

Checks if the communication mode is broadcast.

Returns

• true if the communication mode is Broadcast.
• false if the communication mode is P2P.

pub fn pdu_assignment(&self) -> PduAssignment

Determines the PDU assignment based on the parsed bits.

Returns

• PduAssignment::Sae(bits) for known SAE-defined PDU assignments.
• PduAssignment::Manufacturer(bits) for manufacturer-defined PDU assignments.
• PduAssignment::Unknown(bits) for unrecognized PDU assignments.

Trait Implementations

impl Clone for Pgn

fn clone(&self) -> Pgn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Conversion for Pgn

fn from_bits(bits: u32) -> Self

Creates a new Pgn bitfield from a 32-bit integer.

fn from_hex(hex_str: &str) -> Self

Creates a new Pgn bitfield from a base-16 (hex) string slice.

fn try_from_bits(bits: u32) -> Option<Self>

Creates a new Pgn bitfield from a 32-bit integer.

fn try_from_hex(hex_str: &str) -> Option<Self>

Creates a new Pgn bitfield from a base-16 (hex) string slice.

fn into_bits(self) -> u32

Creates a new 32-bit integer from the Pgn bitfield.

fn into_hex(self) -> String

Creates a new base-16 (hex) String from the Pgn bitfield.

type Type = u32

impl Debug for Pgn

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

Formats the value using the given formatter.

impl Default for Pgn

fn default() -> Self

Returns the “default value” for a type.

impl From<Pgn> for u32

fn from(v: Pgn) -> u32

Converts to this type from the input type.

impl From<u32> for Pgn

fn from(v: u32) -> Self

Converts to this type from the input type.

impl PartialEq for Pgn

fn eq(&self, other: &Pgn) -> 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 Copy for Pgn

impl Eq for Pgn

impl StructuralPartialEq for Pgn