Struct NodeId 

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

A unique 48-bit OpenLCB node identifier, e.g. 05.01.01.01.22.00.

The value is stored in the low 48 bits of a u64; the constructor guarantees the upper 16 bits are always zero. Display and FromStr use the dotted-hex form, Debug prints NodeId(05.01.01.01.22.00). With the serde feature it (de)serializes as the dotted-hex string.

The all-zero ID (NodeId::default()) is not a valid node and is used by this crate as a “not known” placeholder in a few lenient decoders.

Conversions

From	To	How	Out-of-range input
u64	NodeId	NodeId::new	silently masked to 48 bits
u64	NodeId	NodeId::checked	None
u64	NodeId	NodeId::try_from(u64)	Err(ParseError::Length)
[u8; 6]	NodeId	NodeId::from([u8; 6])	(cannot fail)
&[u8]	NodeId	NodeId::from_bytes	Err if shorter than 6 bytes
NodeId	u64	u64::from(id), NodeId::as_u64
NodeId	[u8; 6]	NodeId::to_bytes

use rolcb::NodeId;

let id = NodeId::new(0x0501_0101_2200);
assert_eq!(NodeId::from_bytes(&id.to_bytes())?, id);
assert_eq!(NodeId::from([0x05, 0x01, 0x01, 0x01, 0x22, 0x00]), id);
assert_eq!(u64::from(id), 0x0501_0101_2200);

// `new` DROPS bits above 48 without telling you…
assert_eq!(NodeId::new(0xFFFF_0501_0101_2200), id);
// …so prefer `checked` / `try_from` for values from outside the program.
assert_eq!(NodeId::checked(0xFFFF_0501_0101_2200), None);
assert!(NodeId::try_from(0x1_0000_0000_0000_u64).is_err());
assert_eq!(NodeId::try_from(0x0501_0101_2200_u64)?, id);

Implementations

impl NodeId

pub const MAX: u64 = 0xFFFF_FFFF_FFFF

The largest representable Node ID value, 0xFFFF_FFFF_FFFF (48 bits).

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

Create from the low 48 bits of v.

Bits 48-63 are silently discarded: NodeId::new(0x1_0000_0000_0001) is 00.00.00.00.00.01. That is convenient for literals, but for values read from a file, a UI or another program use NodeId::checked or NodeId::try_from(u64), which reject values above NodeId::MAX instead of truncating them.

pub const fn checked(v: u64) -> Option<Self>

Create from v if it fits in 48 bits, otherwise None.

use rolcb::NodeId;
assert_eq!(NodeId::checked(NodeId::MAX).map(|n| n.as_u64()), Some(NodeId::MAX));
assert_eq!(NodeId::checked(NodeId::MAX + 1), None);

pub const fn as_u64(self) -> u64

The Node ID as an integer (always <= NodeId::MAX).

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

The six big-endian bytes, as transmitted on the wire (for example in the data field of an AMD frame or a Verified Node ID message).

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

Read a Node ID from the first six big-endian bytes of b. Extra trailing bytes are ignored.

Errors

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

Trait Implementations

impl Clone for NodeId

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 NodeId

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Default for NodeId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodeId

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 NodeId

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

Formats the value using the given formatter.

impl Eq for NodeId

impl From<NodeId> for u64

fn from(n: NodeId) -> u64

Converts to this type from the input type.

impl From<[u8; 6]> for NodeId

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

Big-endian bytes, as on the wire.

impl FromStr for NodeId

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 NodeId

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 NodeId

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 NodeId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NodeId

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 NodeId

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 NodeId

impl TryFrom<u64> for NodeId

fn try_from(v: u64) -> Result<Self, ParseError>

Fails with ParseError::Length if v does not fit in 48 bits.

type Error = ParseError

The type returned in the event of a conversion error.