Struct HybridLogicalClock

pub struct HybridLogicalClock {
    pub timestamp: SystemTime,
    pub counter: u64,
    pub node_id: String,
}

Hybrid Logical Clock (HLC) generating unique timestamps

Fields

timestamp: SystemTime

Current timestamp.

counter: u64

Counter is used to coordinate ordering of events within a distributed system where each device may have slightly different system clock times.

node_id: String

Unique identifier for this node.

Implementations

impl HybridLogicalClock

pub fn new() -> Self

Creates a new HybridLogicalClock with the current timestamp, a counter of 0, and a unique identifier

pub fn update( &mut self, other: &HybridLogicalClock, max_clock_drift: Duration, ) -> Result<(), HLCError>

Updates the HybridLogicalClock based on another HybridLogicalClock. Self will be set to the latest timestamp between itself, other, and the current time, and its counter will also be updated accordingly.

Note: Update performed against another HybridLogicalClock with the same node_id is a no-op, and will not result in an error.

Errors

HLCError of kind OverflowWarning if the HybridLogicalClock’s counter would be set to a value that would overflow beyond u64::MAX

HLCError of kind ClockDrift if the latest HybridLogicalClock (of Self or other)’s timestamp is too far in the future (determined by max_clock_drift) compared to SystemTime::now()

pub fn update_now(&mut self, max_clock_drift: Duration) -> Result<(), HLCError>

Updates the HybridLogicalClock based on the current time

Errors

HLCError of kind OverflowWarning if the HybridLogicalClock’s counter would be set to a value that would overflow beyond u64::MAX

HLCError of kind ClockDrift if the HybridLogicalClock timestamp is too far in the future (determined by max_clock_drift) compared to SystemTime::now() compared to SystemTime::now()

Trait Implementations

impl Clone for HybridLogicalClock

fn clone(&self) -> HybridLogicalClock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HybridLogicalClock

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

Formats the value using the given formatter.

impl Default for HybridLogicalClock

fn default() -> Self

Returns the “default value” for a type.

impl Display for HybridLogicalClock

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

Formats the value using the given formatter.

impl FromStr for HybridLogicalClock

type Err = ParseHLCError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, ParseHLCError>

Parses a string s to return a value of this type.

impl PartialEq for HybridLogicalClock

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