Struct can_type_rs::j1939::NameField

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

Represents a Name in the SAE J1939 protocol.

The Name structure is used in the SAE J1939 protocol to represent the identity of a device or component within a vehicle’s network.

Repr: u64

Field	Size (bits)
Arbitrary address bits	1
Industry group bits	3
Vehicle system instance bits	4
Vehicle system bits	7
Reserved bits	1
Function bits	8
Function instance bits	5
ECU instance bits	3
Manufacturer code bits	11
Identity number bits	21

Implementations

impl NameField

pub const fn new() -> Self

Creates a new default initialized bitfield.

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

Convert from bits.

pub const fn into_bits(self) -> u64

Convert into bits.

impl NameField

pub const fn arbitrary_address(&self) -> bool

Indicates whether 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 Clone for NameField

fn clone(&self) -> NameField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Conversion for NameField

fn from_bits(bits: u64) -> Self

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

fn from_hex(hex_str: &str) -> Self

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

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

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

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

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

fn into_bits(self) -> u64

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

fn into_hex(self) -> String

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

type Type = u64

impl Debug for NameField

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

Formats the value using the given formatter.

impl Default for NameField

fn default() -> Self

Returns the “default value” for a type.

impl From<NameField> for u64

fn from(v: NameField) -> u64

Converts to this type from the input type.

impl From<u64> for NameField

fn from(v: u64) -> Self

Converts to this type from the input type.

impl Ord for NameField

fn cmp(&self, other: &NameField) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for NameField

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

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

impl Eq for NameField

impl StructuralPartialEq for NameField