Struct EventId 

pub struct EventId(pub u64);

A 64-bit event identifier, e.g. 05.01.01.01.22.00.00.10.

The inner value is public; EventId(0x0501_0101_2200_0010) is as good as parsing. Display/FromStr use eight dotted hex bytes (separators optional, as for NodeId); with the serde feature the ID (de)serializes as that string. On the wire it is eight big-endian bytes, which fill a whole CAN frame.

Tuple Fields

0: u64

Implementations

impl EventId

pub const EMERGENCY_OFF: EventId

Well-known: Emergency Off (de-energize).

pub const CLEAR_EMERGENCY_OFF: EventId

Well-known: Clear Emergency Off.

pub const EMERGENCY_STOP: EventId

Well-known: Emergency Stop of all operations.

pub const CLEAR_EMERGENCY_STOP: EventId

Well-known: Clear Emergency Stop.

pub const IS_TRAIN: EventId

Well-known: this node is a train (Traction protocol).

pub const DUPLICATE_NODE_ID: EventId

Well-known: a node detected another node using its Node ID (01.01.00.00.00.00.02.01). Node produces this once, as a PCER, when it first detects a duplicate.

pub const fn new(v: u64) -> Self

Wrap a raw 64-bit value. Same as EventId(v), usable in const.

pub const fn as_u64(self) -> u64

The raw 64-bit value.

pub fn to_bytes(self) -> [u8; 8]

The eight big-endian bytes, as carried in event messages.

pub fn from_bytes(b: &[u8]) -> Result<Self, ParseError>

Read an Event ID from the first eight big-endian bytes of b. Extra trailing bytes are ignored.

Errors

ParseError::Length if b is shorter than eight bytes.

Trait Implementations

impl Clone for EventId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EventId

impl Debug for EventId

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

Formats the value using the given formatter.

impl Default for EventId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventId

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for EventId

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

Formats the value using the given formatter.

impl Eq for EventId

impl From<EventId> for u64

fn from(e: EventId) -> u64

Converts to this type from the input type.

impl From<[u8; 8]> for EventId

fn from(b: [u8; 8]) -> Self

Big-endian bytes, as on the wire.

impl From<u64> for EventId

fn from(v: u64) -> Self

Converts to this type from the input type.

impl FromStr for EventId

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for EventId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EventId

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for EventId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EventId

fn partial_cmp(&self, other: &Self) -> 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 Serialize for EventId

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EventId