Struct HlcTimestamp 

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

Hybrid logical clock (HLC) timestamp.

This is a wrapper around raw u64 data of HLC atomic timestamp.

The timestamp is represented as a 64-bit unsigned integer. The upper 42 bits represent the physical time in milliseconds since a custom epoch, and the lower 22 bits represent the logical clock count.

Normally, you don’t need to worry about the details of the representation.

Whenever you need to create a new timestamp, use the new() to create a timestamp with the given time, or from_parts() to create a timestamp with a specific Unix timestamp (in ms) and logical clock count.

To get the physical time and logical clock count, use the parts() which returns a tuple of (pt, lc).

Alternatively, rely on timestamp() and count() methods to get the physical time and logical clock count.

Finally, you can use the as_u64() method to get the raw data, which is guaranteed to be monotonically increasing and capturing the happens-before relationship.

Implementations

impl HlcTimestamp

pub fn new(unix_timestamp: i64) -> HlcResult<Self>

Creates a new HLC timestamp from incoming physical time.

pub fn from_parts(pt: i64, lc: u64) -> HlcResult<Self>

Creates a new HLC timestamp from the given physical time and logical clock count.

pub fn timestamp(&self) -> i64

Unix timestamp in milliseconds.

pub fn count(&self) -> u64

Logical clock count.

pub fn parts(&self) -> (i64, u64)

Returns the physical time and logical clock count as a tuple.

pub fn as_u64(&self) -> u64

Returns the raw u64 value of the HLC ID.

Trait Implementations

impl Add<u64> for HlcTimestamp

type Output = HlcTimestamp

The resulting type after applying the + operator.

fn add(self, ts: u64) -> Self::Output

Performs the + operation.

impl AddAssign<u64> for HlcTimestamp

fn add_assign(&mut self, ts: u64)

Performs the += operation.

impl Clone for HlcTimestamp

fn clone(&self) -> HlcTimestamp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HlcTimestamp

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

Formats the value using the given formatter.

impl Default for HlcTimestamp

fn default() -> HlcTimestamp

Returns the “default value” for a type.

impl Display for HlcTimestamp

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

Formats the value using the given formatter.

impl Hash for HlcTimestamp

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 HlcTimestamp

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

impl PartialEq for HlcTimestamp

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for HlcTimestamp

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

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: &HlcTimestamp) -> Self::Output

Performs the - operation.

impl Sub<&HlcTimestamp> for HlcTimestamp

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: &HlcTimestamp) -> Self::Output

Performs the - operation.

impl Sub<HlcTimestamp> for &HlcTimestamp

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: HlcTimestamp) -> Self::Output

Performs the - operation.

impl Sub<u64> for HlcTimestamp

type Output = HlcTimestamp

The resulting type after applying the - operator.

fn sub(self, ts: u64) -> Self::Output

Performs the - operation.

impl Sub for HlcTimestamp

type Output = i64

The resulting type after applying the - operator.

fn sub(self, rhs: HlcTimestamp) -> Self::Output

Performs the - operation.

impl SubAssign<u64> for HlcTimestamp

fn sub_assign(&mut self, ts: u64)

Performs the -= operation.

impl TryFrom<u64> for HlcTimestamp

type Error = HlcError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for HlcTimestamp

impl Eq for HlcTimestamp

impl StructuralPartialEq for HlcTimestamp