Struct ClockIdentity 

pub struct ClockIdentity(pub [u8; 8]);

The identity of a PTP node.

All ptp clocks in a network need a unique clock identity. A common approach is to use a mac address of the device to generate a unique identifier (see from_mac_address).

For more details, see IEEE1588-2019 section 7.5.2.2.2.

Tuple Fields

0: [u8; 8]

Implementations

impl ClockIdentity

pub fn from_mac_address(addr: [u8; 6]) -> Self

Create a ClockIdentity from a mac address.

Fills the first six bytes with the mac address and the rest with zeroes.

Example

let id = ClockIdentity::from_mac_address([0xA, 0xB, 0xC, 0xD, 0xE, 0xF]);
assert_eq!(id.0, [0xA, 0xB, 0xC, 0xD, 0xE, 0xF, 0x0, 0x0]);

pub fn serialize(self, buffer: &mut [u8]) -> Result<(), Error>

Serialize a clock identity to a buffer of 8 bytes

Errors

Fails when the provided buffer is of insufficient length.

pub fn deserialize(buffer: &[u8]) -> Result<Self, Error>

Deserialize a clock identity from a buffer of 8 bytes

Errors

Fails when the provided buffer is too short.

Trait Implementations

impl Clone for ClockIdentity

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 ClockIdentity

impl Debug for ClockIdentity

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

Formats the value using the given formatter.

impl Default for ClockIdentity

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClockIdentity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClockIdentity

Available on crate feature std only.

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

Formats the value using the given formatter.

impl Eq for ClockIdentity

impl Hash for ClockIdentity

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 ClockIdentity

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 ClockIdentity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ClockIdentity

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 ClockIdentity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClockIdentity