Struct Instant

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

A measurement of a monotonically increasing clock. Opaque and useful only with Duration.

Resulting durations are actual durations; they do not get affected by clock adjustments, leap seconds, or similar. In order to get a measurement of the wall clock, use Date instead.

Implementations

impl Instant

pub fn now() -> Instant

Returns an instant corresponding to “now”

This function also updates the stored instant.

pub fn now_without_cache_update() -> Instant

Returns an instant corresponding to “now” without updating the cached value. After this, recent() will still return the old instant.

now() is generally preferred over this function.

pub fn recent() -> Instant

Returns an instant corresponding to the latest update

pub fn update()

Update the stored instant

This function should be called frequently, for example in an event loop or using an Updater task.

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

Returns the amount of time elapsed from another instant to this one

pub fn elapsed_since_recent(&self) -> Duration

Returns the amount of time elapsed between the this instant was created and the latest update

pub fn elapsed(&self) -> Duration

Returns the amount of time elapsed since this instant was created

This function also updates the stored instant.

pub fn as_ticks(&self) -> u64

Return a representation of this instant as a number of “ticks”.

Note that length of a ‘tick’ is not guaranteed to represent the same amount of time across different platforms, or from one version of coarsetime to another.

Note also that the instant represented by “0” ticks is unspecified. It is not guaranteed to be the same time across different platforms, or from one version of coarsetime to another.

This API is mainly intended for applications that need to store the value of an Instant in an AtomicU64.

pub fn saturating_add(self, rhs: Duration) -> Instant

Calculate an Instant that is a Duration later, saturating on overflow

pub fn checked_add(self, rhs: Duration) -> Option<Instant>

Calculate an Instant that is a Duration later, returning None on overflow

pub fn saturating_sub(self, rhs: Duration) -> Instant

Calculate an Instant that is a Duration earlier, saturating on underflow

pub fn checked_sub(self, rhs: Duration) -> Option<Instant>

Calculate an Instant that is a Duration earlier, returning None on underflow

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Instant

Performs the + operation.

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Clone for Instant

fn clone(&self) -> Instant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instant

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

Formats the value using the given formatter.

impl Default for Instant

fn default() -> Instant

Returns the “default value” for a type.

impl Hash for Instant

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 Instant

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

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

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

type Output = Instant

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Instant

Performs the - operation.

impl Sub for Instant

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl Copy for Instant

impl Eq for Instant

impl StructuralPartialEq for Instant