Struct uhlc::NTP64

pub struct NTP64(pub u64);

A NTP 64-bits format as specified in RFC-5909

0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                            Seconds                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                            Fraction                           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The 1st 32-bits part is the number of second since the EPOCH of the physical clock, and the 2nd 32-bits part is the fraction of second.
In case it’s part of a crate::Timestamp generated by an crate::HLC the last few bits of the Fraction part are replaced by the HLC logical counter. The size of this counter currently hard-coded as crate::CSIZE.

Note that this timestamp in actually similar to a std::time::Duration, as it doesn’t define an EPOCH. Only the NTP64::to_system_time() and std::fmt::Display::fmt() operations assume that it’s relative to UNIX_EPOCH (1st Jan 1970) to display the timpestamp in RFC-3339 format.

Tuple Fields

0: u64

Implementations

impl NTP64

pub fn as_u64(&self) -> u64

Returns this NTP64 as a u64.

pub fn as_secs_f64(&self) -> f64

Returns this NTP64 as a f64 in seconds.

The integer part of the f64 is the NTP64’s Seconds part.
The decimal part of the f64 is the result of a division of NTP64’s Fraction part divided by 2^32.
Considering the probable large number of Seconds (for a time relative to UNIX_EPOCH), the precision of the resulting f64 might be in the order of microseconds. Therefore, it should not be used for comparison. Directly comparing NTP64 objects is preferable.

pub fn as_secs(&self) -> u32

Returns the 32-bits seconds part.

pub fn subsec_nanos(&self) -> u32

Returns the 32-bits fraction of second part converted to nanoseconds.

pub fn to_duration(self) -> Duration

Convert to a Duration.

pub fn to_system_time(self) -> SystemTime

Convert to a SystemTime (making the assumption that this NTP64 is relative to UNIX_EPOCH).

Trait Implementations

impl Add<&NTP64> for &NTP64

type Output = <NTP64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &NTP64) -> <NTP64 as Add<NTP64>>::Output

Performs the + operation.

impl Add<&NTP64> for NTP64

type Output = <NTP64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: &NTP64) -> <NTP64 as Add<NTP64>>::Output

Performs the + operation.

impl<'a> Add<NTP64> for &'a NTP64

type Output = <NTP64 as Add>::Output

The resulting type after applying the + operator.

fn add(self, other: NTP64) -> <NTP64 as Add<NTP64>>::Output

Performs the + operation.

impl Add<u64> for NTP64

type Output = NTP64

The resulting type after applying the + operator.

fn add(self, other: u64) -> Self

Performs the + operation.

impl Add for NTP64

type Output = NTP64

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign<u64> for NTP64

fn add_assign(&mut self, other: u64)

Performs the += operation.

impl Clone for NTP64

fn clone(&self) -> NTP64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NTP64

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

Formats the value using the given formatter.

impl Default for NTP64

fn default() -> NTP64

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NTP64

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NTP64

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

Formats the value using the given formatter.

impl From<Duration> for NTP64

fn from(duration: Duration) -> NTP64

Converts to this type from the input type.

impl FromStr for NTP64

type Err = ParseNTP64Error

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 NTP64

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 NTP64

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NTP64

fn partial_cmp(&self, other: &NTP64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for NTP64

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<&NTP64> for &NTP64

type Output = <NTP64 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: &NTP64) -> <NTP64 as Sub<NTP64>>::Output

Performs the - operation.

impl Sub<&NTP64> for NTP64

type Output = <NTP64 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: &NTP64) -> <NTP64 as Sub<NTP64>>::Output

Performs the - operation.

impl<'a> Sub<NTP64> for &'a NTP64

type Output = <NTP64 as Sub>::Output

The resulting type after applying the - operator.

fn sub(self, other: NTP64) -> <NTP64 as Sub<NTP64>>::Output

Performs the - operation.

impl Sub<u64> for NTP64

type Output = NTP64

The resulting type after applying the - operator.

fn sub(self, other: u64) -> Self

Performs the - operation.

impl Sub for NTP64

type Output = NTP64

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign<u64> for NTP64

fn sub_assign(&mut self, other: u64)

Performs the -= operation.

impl Copy for NTP64

impl Eq for NTP64

impl StructuralPartialEq for NTP64