Struct Instant

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

Represents a time on a monotonically increasing clock (i.e., time since program start).

This type has a precision of 1 microsecond.

Implementations

impl Instant

pub fn from_micros(micros: u64) -> Self

Creates a new Instant from the specified number of whole microseconds since program start.

pub fn from_millis(millis: u64) -> Self

Creates a new Instant from the specified number of whole milliseconds since program start.

pub fn from_secs(secs: u64) -> Self

Creates a new Instant from the specified number of whole seconds since program start.

pub fn as_millis(&self) -> u64

Returns the number of whole seconds since program start contained by this Instant.

The returned value does not include the fractional (milliseconds) part of the time value.

pub fn as_secs(&self) -> u64

Returns the number of whole seconds since program start contained by this Instant.

pub fn as_micros(&self) -> u64

Returns the number of whole microseconds since program start contained by this Instant.

pub fn subsec_millis(&self) -> u64

Returns the fractional part of this Instant, in whole milliseconds.

This method does not return the time value in milliseconds. The returned number always represents a fractional portion of a second (i.e., it is less than one thousand).

pub fn subsec_micros(&self) -> u64

Returns the fractional part of this Instant, in whole microseconds.

This method does not return the time value in microseconds. The returned number always represents a fractional portion of a second (i.e., it is less than one million).

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

Checked addition of a Duration to an Instant. Computes self + rhs, returning None if overflow occurred.

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

Checked subtraction of a Duration from an Instant. Computes self - rhs, returning None if the result would be negative or overflow occurred.

pub fn checked_sub_instant(self, rhs: Self) -> Option<Duration>

Checked subtraction of two Instants. Computes self - rhs, returning None if the result would be negative or overflow occurred.

pub fn checked_mul(self, rhs: u64) -> Option<Instant>

Checked multiplication of an Instant by a scalar. Computes self * rhs, returning None if an overflow occurred.

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

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.

const 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 Div<u64> for Instant

type Output = Instant

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl DivAssign<u64> for Instant

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl Mul<u64> for Instant

type Output = Instant

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl MulAssign<u64> for Instant

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

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

const 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) -> Self::Output

Performs the - operation.

impl Sub for Instant

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

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