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 = _

pub fn from_micros<T: Into<i64>>(micros: T) -> Instant

Create a new Instant from a number of microseconds.

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

pub fn from_millis<T: Into<i64>>(millis: T) -> Instant

Create a new Instant from a number of milliseconds.

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

Create a new Instant from a number of milliseconds.

pub fn from_secs<T: Into<i64>>(secs: T) -> Instant

Create a new Instant from a number of seconds.

pub const fn millis(&self) -> i64

The fractional number of milliseconds that have passed since the beginning of time.

pub const fn micros(&self) -> i64

The fractional number of microseconds that have passed since the beginning of time.

pub const fn secs(&self) -> i64

The number of whole seconds that have passed since the beginning of time.

pub const fn total_millis(&self) -> i64

The total number of milliseconds that have passed since the beginning of time.

pub const fn total_micros(&self) -> i64

The total number of milliseconds that have passed since the beginning of time.

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

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

Formats the value using the given formatter.

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, rhs: 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