Struct Instant 

pub struct Instant { /* private fields */ }

A representation of an absolute time value.

The Instant type is a wrapper around a i64 value that represents a number of microseconds, monotonically increasing since an arbitrary moment in time, such as system startup.

• A value of 0 is inherently arbitrary.
• A value less than 0 indicates a time before the starting point.

Implementations

impl Instant

pub const ZERO: Instant

The starting point.

pub const MIN: Instant

The earliest representable instant.

pub const MAX: Instant

The latest representable instant.

pub const fn from_micros(micros: i64) -> Instant

Create a new Instant from a number of microseconds.

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

Create a new Instant from a number of milliseconds.

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

Create a new Instant from a number of seconds.

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_secs(&self) -> i64

The number of whole seconds since the starting point.

Truncates towards zero for instants before the starting point.

pub const fn as_millis(&self) -> i64

The number of milliseconds since the starting point.

pub const fn as_micros(&self) -> i64

The number of microseconds since the starting point.

pub const fn subsec_millis(&self) -> i64

The number of milliseconds past as_secs.

Always less than 1000 in absolute value.

pub const fn subsec_micros(&self) -> i64

The number of microseconds past as_secs.

Always less than 1000000 in absolute value.

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.

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.

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.

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

This instant plus duration, or None if the result does not fit.

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

This instant minus duration, or None if the result does not fit.

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

Converts to this type from the input type.

impl From<Instant> for SystemTime

Available on crate feature std only.

fn from(val: Instant) -> Self

Converts to this type from the input type.

impl From<SystemTime> for Instant

Available on crate feature std only.

fn from(other: SystemTime) -> Instant

Converts to this type from the input type.

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

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.