Enum ClockSkew

pub enum ClockSkew {
    Slow(Duration),
    None,
    Fast(Duration),
}

A reported amount of clock skew from a relay or other source.

Note that this information may not be accurate or trustworthy: the relay could be wrong, or lying.

The skews reported here are minimum amounts; the actual skew may be a little higher, depending on latency.

Variants

Slow(Duration)

Our own clock is “running slow”: the relay’s clock is at least this far ahead of ours.

None

Our own clock is not necessarily inconsistent with the relay’s clock.

Fast(Duration)

Own own clock is “running fast”: the relay’s clock is at least this far behind ours.

Implementations

impl ClockSkew

pub(crate) fn from_handshake_timestamps( ours_at_start: SystemTime, theirs: SystemTime, delay: Duration, ) -> Self

Construct a ClockSkew from a set of channel handshake timestamps.

Requires that ours_at_start is the timestamp at the point when we started the handshake, theirs is the timestamp the relay reported in its NETINFO cell, and delay is the total amount of time between when we started the handshake and when we received the NETINFO cell.

pub fn magnitude(&self) -> Duration

Return the magnitude of this clock skew.

pub fn as_secs_f64(&self) -> f64

Return this clock skew as a signed number of seconds, with slow values treated as negative and fast values treated as positive.

pub fn from_secs_f64(seconds: f64) -> Option<Self>

Return a clock skew computed from a signed number of seconds.

Returns None if the value is degenerate.

pub fn if_above(self, min: Duration) -> Self

Return this value if it is greater than min; otherwise return None.

pub fn is_skewed(&self) -> bool

Return true if we’re estimating any skew.

Trait Implementations

impl Clone for ClockSkew

fn clone(&self) -> ClockSkew

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClockSkew

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

Formats the value using the given formatter.

impl Ord for ClockSkew

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.

impl PartialEq for ClockSkew

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

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 Copy for ClockSkew

impl Eq for ClockSkew

impl StructuralPartialEq for ClockSkew