Struct tor_rtcompat::CoarseInstant

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

A monotonic timestamp with reduced precision, and, in the future, saturating arithmetic

Like std::time::Instant, but:

• RealCoarseTimeProvider::now_coarse() is cheap on all platforms, unlike std::time::Instant::now.

• Not true yet: Arithmetic is saturating (so, it’s panic-free).

• Precision and accuracy are reduced.

• Cannot be compared with, or converted to/from, std::time::Instant. It has a completely different timescale to Instant.

You can obtain this (only) from CoarseTimeProvider::now_coarse.

Range and precision

The range of a CoarseInstant is not directly visible, since the absolute value isn’t. CoarseInstants are valid only within the context of one program execution (process).

Correct behaviour with processes that run for more than 2^31 seconds (about 30 years) is not guaranteed.

The precision is no worse than 1 second.

Panics

Currently, operations on CoarseInstant and CoarseDuration can panic on under/overflow. We regard this as a bug. The intent is that all operations will saturate.

Trait Implementations

impl Add<CoarseDuration> for CoarseInstant

type Output = CoarseInstant

The resulting type after applying the + operator.

fn add(self, rhs: CoarseDuration) -> CoarseInstant

Performs the + operation.

impl AddAssign<CoarseDuration> for CoarseInstant

fn add_assign(&mut self, rhs: CoarseDuration)

Performs the += operation.

impl Clone for CoarseInstant

fn clone(&self) -> CoarseInstant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoarseInstant

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

Formats the value using the given formatter.

impl Hash for CoarseInstant

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 CoarseInstant

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

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

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

type Output = CoarseInstant

The resulting type after applying the - operator.

fn sub(self, rhs: CoarseDuration) -> CoarseInstant

Performs the - operation.

impl SubAssign<CoarseDuration> for CoarseInstant

fn sub_assign(&mut self, rhs: CoarseDuration)

Performs the -= operation.

impl Copy for CoarseInstant

impl Eq for CoarseInstant

impl StructuralPartialEq for CoarseInstant