Struct uhlc::Timestamp

pub struct Timestamp { /* private fields */ }

A timestamp made of a NTP64 and a crate::HLC’s unique identifier.

Conversion to/from String

A Timestamp is formatted to a String as such: "<ntp64_time>/<hlc_id_hexadecimal>" 2 different String representations are supported:

1. <ntp64_time> as an unsigned integer in decimal format

• Such conversion is lossless and thus bijective.
• Timestamp to String: use std::fmt::Display::fmt() or std::string::ToString::to_string().
• String to Timestamp: use std::str::FromStr::from_str()

2. <ntp64_time>as a RFC3339 (human readable) format:

• Such conversion loses some precision because of rounding when conferting the fraction part to nanoseconds
• As a consequence it’s not bijective: a Timestamp converted to RFC3339 String and then converted back to Timestamp might result to a different time.
• Timestamp to String: use std::fmt::Display::fmt() with the alternate flag ({:#}) or Timestamp::to_string_rfc3339_lossy().
• String to Timestamp: use Timestamp::parse_rfc3339()

Implementations

impl Timestamp

pub fn new(time: NTP64, id: ID) -> Timestamp

pub fn get_time(&self) -> &NTP64

pub fn get_id(&self) -> &ID

pub fn get_diff_duration(&self, other: &Timestamp) -> Duration

pub fn to_string_rfc3339_lossy(&self) -> String

Convert to a RFC3339 time representation with nanoseconds precision. e.g.: `“2024-07-01T13:51:12.129693000Z/33”``

pub fn parse_rfc3339(s: &str) -> Result<Self, ParseTimestampError>

Parse a RFC3339 time representation into a NTP64.

Trait Implementations

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timestamp

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Timestamp

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

Formats Timestamp as the time part followed by the ID part, with / as separator.
By default the time part is formatted as an unsigned integer in decimal format.
If the alternate flag {:#} is used, the time part is formatted with RFC3339 representation with nanoseconds precision.

Examples

  use uhlc::*;
  use std::convert::TryFrom;

  let t =Timestamp::new(NTP64(7386690599959157260), ID::try_from([0x33]).unwrap());
  println!("{t}");    // displays: 7386690599959157260/33
  println!("{t:#}");  // displays: 2024-07-01T15:32:06.860479000Z/33

impl FromStr for Timestamp

type Err = ParseTimestampError

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 Timestamp

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 Timestamp

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp