Struct pausable_clock::PausableInstant

pub struct PausableInstant { /* fields omitted */ }

Native representation of a paused instant that contains the reference time and the elapsed time on the clock from the reference time.

Note on PartialOrd/Ord

The derived Ord and PartialOrd behavior is only valid for PausableInstants from the same clock. While the compare functions from ord and partial_ord can be called on PausableInstants from different clocks without panics, the results will have no guaranteed order

Implementations

impl PausableInstant

pub fn elapsed_millis(&self) -> u64

Get this pausable instant’s elapsed millis.

pub fn zero_instant(&self) -> Instant

Get the instant this pausable instant is referenced off of

pub fn elapsed(&self, originating_clock: &PausableClock) -> Duration

Get the elapsed time since this instant according to the given (and ideally originating) clock.

#Panics

This function will panic If the given clock produces a now() instant that is “before” this one. This is guaranteed not to happen if the given clock is the originating clock

pub fn duration_since(&self, earlier: PausableInstant) -> Duration

Returns the amount of time elapsed from another instant to this one according to the pausable clock. Ideally the given instant is from the same pausable clock otherwise the resulting duration is meaningless.

#Panics

This function will panic if the given instant is “later” than this one.

pub fn checked_duration_since(
    &self,
    earlier: &PausableInstant
) -> Option<Duration>

Returns the amount of time elapsed from another instant to this one according to the pausable clock. Ideally the given instant is from the same pausable clock otherwise the resulting duration is meaningless.

This function will return None if the given instant is “later” than this one.

pub fn saturating_duration_since(&self, earlier: &PausableInstant) -> Duration

Returns the amount of time elapsed from another instant to this one according to the pausable clock. Ideally the given instant is from the same pausable clock otherwise the resulting duration is meaningless.

This function will return zero if the given instant is “later” than this one.

pub fn checked_add(&self, duration: Duration) -> Option<PausableInstant>

Returns Some(t) where t is the time self + duration if the given duration can be represented in milliseconds as a u64 and this pausable instant’s elapsed milliseconds plus the duration in millis can also be represented as a u64.

Effectively this means the resulting duration since the elapse millis needs to be less than about 500 million years.

pub fn checked_sub(&self, duration: Duration) -> Option<PausableInstant>

Returns Some(t) where t is the time self - duration if the given duration can be represented in milliseconds as a u64, and this pausable instant’s elapsed milliseconds >= the duration in milliseconds

Effectively this means the given duration needs to be less than about 500 million years, and the resulting instant cannot be before the zero instant of this pausable instant.

Trait Implementations

impl Add<Duration> for PausableInstant

fn add(self, other: Duration) -> Self::Output

#Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See PausableInstant::checked_add for a version without panic.

type Output = PausableInstant

The resulting type after applying the + operator.

impl AddAssign<Duration> for PausableInstant

fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl Clone for PausableInstant

fn clone(&self) -> PausableInstant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PausableInstant

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

Formats the value using the given formatter.

impl From<PausableInstant> for Instant

fn from(source: PausableInstant) -> Self

Convert from the given pausable instant to a std instant. This is helpful for working with other libraries that need time info, but it has minor risks because once converted to a std instant, functions like elapsed() and duration_since() will produce unexpected results because those functions compare against the actual time and not the pausable time.

impl Hash for PausableInstant

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for PausableInstant

fn cmp(&self, other: &PausableInstant) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PausableInstant> for PausableInstant

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<PausableInstant> for PausableInstant

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

fn sub(self, other: Duration) -> PausableInstant

#Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See PausableInstant::checked_sub for a version without panic.

type Output = PausableInstant

The resulting type after applying the - operator.

impl Sub<PausableInstant> for PausableInstant

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: PausableInstant) -> Duration

Performs the - operation.

impl SubAssign<Duration> for PausableInstant

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.

impl Copy for PausableInstant

impl Eq for PausableInstant

impl StructuralEq for PausableInstant

impl StructuralPartialEq for PausableInstant