Struct Message

pub struct Message<P: IsProtocol, U: IsDataUnit> { /* private fields */ }

Represents a CAN message with its associated identifier (Id) and protocol data unit (Pdu).

Implementations

impl Message<J1939, Data>

pub fn from_parts(id: Id<J1939>, pdu: Pdu<Data>) -> Self

Constructs a new Message from its parts: a 29-bit J1939 identifier and pdu containing 64 bits of generic data.

Arguments

• id: An Id<J1939> representing the 29-bit identifier of the message.
• pdu: A Pdu<Data> containing the payload or content of the message.

Returns

A new Message instance initialized with the provided parts.

pub fn into_parts(self) -> (Id<J1939>, Pdu<Data>)

Destructures the Message into its parts: a 29-bit J1939 identifier and pdu containing 64 bits of generic data.

Returns

A tuple containing:

• An Id<J1939> representing the 29-bit identifier.
• A Pdu<Data> containing the payload or content of the message.

pub fn try_from_bits(hex_id: u32, hex_pdu: u64) -> Result<Self, Error>

Constructs a new Message from raw bit representations of its components.

Errors

• If failed to construct the identifier field from bits
• If failed to construct the pdu field from bits

pub fn try_from_hex(hex_id: &str, hex_pdu: &str) -> Result<Self, Error>

Constructs a new Message from hexadecimal string representations of its components.

Errors

• If failed to construct the identifier field from hex
• If failed to construct the pdu field from hex

pub fn from_bits(hex_id: u32, hex_pdu: u64) -> Self

Constructs a new Message from raw bit representations of its components.

Arguments

• hex_id: A u32 representing the hexadecimal encoded 29-bit J1939 identifier.
• hex_pdu: A u64 representing the hexadecimal encoded pdu.

Returns

A new Message instance initialized with the decoded components.

pub fn from_hex(hex_id: &str, hex_pdu: &str) -> Self

Constructs a new Message from hexadecimal string representations of its components.

Arguments

• hex_id: A &str representing the hexadecimal encoded 29-bit J1939 identifier.
• hex_pdu: A &str representing the hexadecimal encoded pdu.

Returns

A new Message instance initialized with the decoded components.

pub fn id(&self) -> Id<J1939>

Retrieves the 29-bit J1939 identifier from the message.

Returns

The Id<J1939> bitfield associated with the message.

pub fn pdu(&self) -> Pdu<Data>

Retrieves the pdu from the message.

Returns

The Pdu<Data> bitfield associated with the message.

impl Message<J1939, Name>

pub fn from_parts(id: Id<J1939>, pdu: Pdu<Name>) -> Self

Constructs a new Message from its parts: an identifier and pdu.

Arguments

• id: An Id<J1939> representing the 29-bit identifier of the message.
• pdu: A Pdu<Data> containing the payload or content of the message.

Returns

A new Message instance initialized with the provided parts.

pub fn into_parts(self) -> (Id<J1939>, Pdu<Name>)

Destructures the Message into its parts: an identifier and pdu.

Returns

A tuple containing:

• An Id<J1939> representing the 29-bit identifier.
• A Pdu<Data> containing the payload or content of the message.

pub fn try_from_bits(hex_id: u32, hex_pdu: u64) -> Result<Self, Error>

Constructs a new Message from raw bit representations of its components.

Errors

• If failed to construct the identifier field from bits
• If failed to construct the pdu field from bits

pub fn try_from_hex(hex_id: &str, hex_pdu: &str) -> Result<Self, Error>

Constructs a new Message from hexadecimal string representations of its components.

Errors

• If failed to construct the identifier field from hex
• If failed to construct the pdu field from hex

pub fn from_bits(hex_id: u32, hex_pdu: u64) -> Self

Constructs a new Message from raw bit representations of its components.

Arguments

• hex_id: A u32 representing the hexadecimal encoded 29-bit identifier.
• hex_pdu: A u64 representing the hexadecimal encoded pdu.

Returns

A new Message instance initialized with the decoded components.

pub fn from_hex(hex_id: &str, hex_pdu: &str) -> Self

Constructs a new Message from hexadecimal string representations of its components.

Arguments

• hex_id: A &str representing the hexadecimal encoded 29-bit identifier.
• hex_pdu: A &str representing the hexadecimal encoded pdu.

Returns

A new Message instance initialized with the decoded components.

pub fn id(&self) -> Id<J1939>

Retrieves the 29-bit identifier from the message.

Returns

The Id<J1939> bitfield associated with the message.

pub fn pdu(&self) -> Pdu<Name>

Retrieves the pdu from the message.

Returns

The Pdu<Data> bitfield associated with the message.

Trait Implementations

impl<P: Clone + IsProtocol, U: Clone + IsDataUnit> Clone for Message<P, U>

fn clone(&self) -> Message<P, U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + IsProtocol, U: Debug + IsDataUnit> Debug for Message<P, U>

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

Formats the value using the given formatter.

impl From<Message<J1939, Data>> for Message<J1939, Name>

fn from(value: Message<J1939, Data>) -> Self

Converts to this type from the input type.

impl From<Message<J1939, Name>> for Message<J1939, Data>

fn from(value: Message<J1939, Name>) -> Self

Converts to this type from the input type.

impl<P: Ord + IsProtocol, U: Ord + IsDataUnit> Ord for Message<P, U>

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

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

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

impl<P: Eq + IsProtocol, U: Eq + IsDataUnit> Eq for Message<P, U>

impl<P: IsProtocol, U: IsDataUnit> StructuralPartialEq for Message<P, U>