Struct Pdu

pub struct Pdu<U: IsDataUnit>(/* private fields */);

Represents a Protocol Data Unit (PDU) in the context of Controller Area Network (CAN).

Implementations

impl Pdu<Data>

pub const fn byte_0(self) -> u8

Retrieve byte 0.

pub const fn byte_1(self) -> u8

Retrieve byte 1.

pub const fn byte_2(self) -> u8

Retrieve byte 2.

pub const fn byte_3(self) -> u8

Retrieve byte 3.

pub const fn byte_4(self) -> u8

Retrieve byte 4.

pub const fn byte_5(self) -> u8

Retrieve byte 5.

pub const fn byte_6(self) -> u8

Retrieve byte 6.

pub const fn byte_7(self) -> u8

Retrieve byte 7.

pub const fn to_le_bytes(&self) -> [u8; 8]

Return the 64-bit Data bitfield as little-endian bytes.

pub const fn to_be_bytes(&self) -> [u8; 8]

Return the 64-bit Data bitfield as big-endian bytes.

pub const fn to_ne_bytes(&self) -> [u8; 8]

Return the 64-bit Data bitfield as native-endian bytes.

pub const fn to_le(&self) -> Self

Convert the Data bitfield to little-endian byte format.

pub const fn to_be(&self) -> Self

Convert the Data bitfield to big-endian byte format.

impl Pdu<Name>

pub const fn arbitrary_address(&self) -> bool

Indicates whether or not the ECU/CA can negotiate an address (true = yes; false = no).

pub const fn industry_group(&self) -> u8

These codes are associated with particular industries such as on-highway equipment, agricultural equipment, and more.

pub const fn vehicle_system_instance(&self) -> u8

Assigns a number to each instance on the Vehicle System (in case you connect several networks – e.g. connecting cars on a train).

pub const fn vehicle_system(&self) -> u8

Vehicle systems are associated with the Industry Group and they can be, for instance, “tractor” in the “Common” industry or “trailer” in the “On-Highway” industry group.

pub const fn reserved(&self) -> bool

Always zero(false).

pub const fn function(&self) -> u8

This code, in a range between 128 and 255, is assigned according to the Industry Group. A value between 0 and 127 is not associated with any other parameter.

pub const fn function_instance(&self) -> u8

Returns the function instance.

pub const fn ecu_instance(&self) -> u8

A J1939 network may accommodate several ECUs of the same kind (i.e. same functionality). The Instance code separates them.

pub const fn manufacturer_code(&self) -> u16

The 11-Bit Manufacturer Code is assigned by the SAE.

pub const fn identity_number(&self) -> u32

This field is assigned by the manufacturer, similar to a serial number, i.e. the code must be uniquely assigned to the unit.

Trait Implementations

impl<U: Clone + IsDataUnit> Clone for Pdu<U>

fn clone(&self) -> Pdu<U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Conversion<u64> for Pdu<Data>

fn from_bits(bits: u64) -> Self

Creates a new Data bitfield from a 64-bit integer.

fn from_hex(hex_str: &str) -> Self

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

fn try_from_bits(bits: u64) -> Result<Self, Self::Error>

Creates a new Data bitfield from a 64-bit integer.

Errors

• Never (conversion is trivial)

fn try_from_hex(hex_str: &str) -> Result<Self, Self::Error>

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

Errors

• If failed to parse input hexadecimal string slice.

fn into_bits(self) -> u64

Creates a new 64-bit integer from the Data bitfield.

fn into_hex(self) -> String

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

Requires

• alloc

type Error = Error

impl Conversion<u64> for Pdu<Name>

fn from_bits(bits: u64) -> Self

Creates a new Name bitfield from a 64-bit integer.

fn from_hex(hex_str: &str) -> Self

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

fn try_from_bits(bits: u64) -> Result<Self, Self::Error>

Creates a new Name bitfield from a 64-bit integer.

Errors

• Never (conversion is trivial)

fn try_from_hex(hex_str: &str) -> Result<Self, Self::Error>

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

Errors

• If invalid encoding of provided Base16 string
• If insufficient output buffer length

fn into_bits(self) -> u64

Creates a new 64-bit integer from the Name bitfield.

fn into_hex(self) -> String

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

Requires

• alloc

type Error = Error

impl<U: Debug + IsDataUnit> Debug for Pdu<U>

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

Formats the value using the given formatter.

impl From<Pdu<Data>> for Pdu<Name>

fn from(value: Pdu<Data>) -> Self

Converts to this type from the input type.

impl From<Pdu<Name>> for Pdu<Data>

fn from(value: Pdu<Name>) -> Self

Converts to this type from the input type.

impl<U: Ord + IsDataUnit> Ord for Pdu<U>

fn cmp(&self, other: &Pdu<U>) -> 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<U: PartialEq + IsDataUnit> PartialEq for Pdu<U>

fn eq(&self, other: &Pdu<U>) -> 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<U: PartialOrd + IsDataUnit> PartialOrd for Pdu<U>

fn partial_cmp(&self, other: &Pdu<U>) -> 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<U: Copy + IsDataUnit> Copy for Pdu<U>

impl<U: Eq + IsDataUnit> Eq for Pdu<U>

impl<U: IsDataUnit> StructuralPartialEq for Pdu<U>