Struct cap_primitives::time::Instant

pub struct Instant { /* fields omitted */ }

A measurement of a monotonically nondecreasing clock.

This corresponds to std::time::Instant.

Note that this Instant has no now or elapsed methods. To obtain the current time or measure the duration to the current time, you must first obtain a MonotonicClock, and then call MonotonicClock::now or MonotonicClock::elapsed instead.

Implementations

impl Instant

pub const fn from_std(std: Instant) -> Self

Constructs a new instance of Self from the given std::time::Instant.

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

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

This corresponds to std::time::Instant::duration_since.

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

Returns the amount of time elapsed from another instant to this one, or None if that instant is later than this one.

This corresponds to std::time::Instant::checked_duration_since.

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

Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.

This corresponds to std::time::Instant::saturating_duration_since.

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

Returns Some(t) where t is the time self + duration if t can be represented as Instant (which means it's inside the bounds of the underlying data structure), None otherwise.

This corresponds to std::time::Instant::checked_add.

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

Returns Some(t) where t is the time self - duration if t can be represented as Instant (which means it's inside the bounds of the underlying data structure), None otherwise.

This corresponds to std::time::Instant::checked_sub.

Trait Implementations

impl Add<Duration> for Instant

type Output = Self

The resulting type after applying the + operator.

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

Panics

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

impl AddAssign<Duration> for Instant

fn add_assign(&mut self, other: 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 Copy for Instant

impl Debug for Instant

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

Formats the value using the given formatter.

impl Eq for Instant

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, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Instant> for Instant

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

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

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

This method tests for !=.

impl PartialOrd<Instant> 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: &Instant) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Instant) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Instant) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Instant) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Instant

impl StructuralPartialEq for Instant

impl Sub<Duration> for Instant

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Instant> for Instant

type Output = Duration

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Duration> for Instant

fn sub_assign(&mut self, other: Duration)

Performs the -= operation.