Struct Instant 

pub struct Instant { /* private fields */ }

A point in time.

An Instant counts milliseconds from an arbitrary starting point, such as system startup. It wraps around to zero every 2³² ms, about 49.7 days. To make one from a wider timestamp, keep its low 32 bits.

Comparisons take the wraparound into account. Of two instants less than 2³¹ ms (about 24.8 days) apart, the earlier one is the smaller one, even if the counter wrapped around in between. Instants further apart than that compare the wrong way around. This is why Instant implements PartialOrd but not Ord.

The stack keeps every instant it holds close enough to the current time to compare correctly, as long as Stack::poll is called by the deadline it returns.

Implementations

impl Instant

pub const ZERO: Instant

The starting point.

pub const fn from_millis(millis: u32) -> Instant

Create a new Instant from a number of milliseconds.

pub const fn from_secs(secs: u32) -> Instant

Create a new Instant from a number of seconds.

Wraps around like the instant itself.

pub fn now() -> Instant

Create a new Instant from the current std::time::SystemTime.

Requires the std feature.

See std::time::SystemTime::now

pub const fn as_millis(&self) -> u32

The number of milliseconds since the starting point, wrapped around.

pub const fn as_secs(&self) -> u32

The number of whole seconds in as_millis.

pub const fn subsec_millis(&self) -> u32

The number of milliseconds past as_secs.

Always less than 1000.

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

The amount of time elapsed from earlier to this instant.

Returns Duration::ZERO if earlier is later than this instant. Saturates at Duration::MAX.

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

The amount of time elapsed from earlier to this instant.

Returns None if earlier is later than this instant. Saturates at Duration::MAX.

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

The amount of time elapsed from earlier to this instant.

Returns Duration::ZERO if earlier is later than this instant. Saturates at Duration::MAX.

pub fn min(self, other: Instant) -> Instant

The earlier of two instants.

pub fn max(self, other: Instant) -> Instant

The later of two instants.

pub fn elapsed(&self) -> Duration

The amount of time elapsed since this instant.

Requires the std feature. Returns Duration::ZERO if this instant is in the future.

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 duplicate 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 Display for Instant

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

Formats the value using the given formatter.

impl Eq for Instant

impl From<Instant> for Instant

Available on crate feature std only.

fn from(other: Instant) -> Instant

Counts from the first std::time::Instant converted, and wraps around like any other Instant.

impl From<SystemTime> for Instant

Available on crate feature std only.

fn from(other: SystemTime) -> Instant

Counts from the unix epoch, and wraps around like any other Instant.

impl PartialEq for Instant

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for Instant

impl Sub for Instant

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

Saturates to Duration::ZERO if rhs is later than self, like Instant::duration_since.

type Output = Duration

The resulting type after applying 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 SubAssign<Duration> for Instant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.