Struct easytime::Instant

source ·
pub struct Instant(/* private fields */);
Expand description

A measurement of a monotonically nondecreasing clock. Opaque and useful only with Duration.

Instants are always guaranteed to be no less than any previously measured instant when created, and are often useful for tasks such as measuring benchmarks or timing how long an operation takes.

Note, however, that instants are not guaranteed to be steady. In other words, each tick of the underlying clock may not be the same length (e.g. some seconds may be longer than others). An instant may jump forwards or experience time dilation (slow down or speed up), but it will never go backwards.

Instants are opaque types that can only be compared to one another. There is no method to get “the number of seconds” from an instant. Instead, it only allows measuring the duration between two instants (or comparing two instants).

The size of an Instant struct may vary depending on the target operating system.

§OS-specific behaviors

An Instant is a wrapper around system-specific types and it may behave differently depending on the underlying operating system.

See the standard library documentation for more.

§Underlying System calls

See the standard library documentation for the system calls used to get the current time using now().

Implementations§

source§

impl Instant

source

pub const NONE: Self = _

Returns a “none” value

source

pub fn now() -> Self

Returns an instant corresponding to “now”.

§Examples
use easytime::Instant;

let now = Instant::now();
source

pub fn 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.

§Examples
use std::{thread::sleep, time};

use easytime::Instant;

let now = Instant::now();
sleep(time::Duration::new(1, 0));
let new_now = Instant::now();
println!("{:?}", new_now.duration_since(now));
println!("{:?}", now.duration_since(new_now)); // Some(0ns)
source

pub fn elapsed(&self) -> Duration

Returns the amount of time elapsed since this instant was created.

§Examples
use std::{thread::sleep, time};

use easytime::Instant;

let instant = Instant::now();
let three_secs = time::Duration::from_secs(3);
sleep(three_secs);
assert!(instant.elapsed() >= three_secs);
source

pub const fn is_some(&self) -> bool

Returns true if into_inner returns Some.

source

pub const fn is_none(&self) -> bool

Returns true if into_inner returns None.

source

pub const fn into_inner(self) -> Option<Instant>

Returns the contained std::time::Instant or None.

source

pub const fn unwrap_or(self, default: Instant) -> Instant

Returns the contained std::time::Instant or a default.

instant.unwrap_or(default) is equivalent to instant.into_inner().unwrap_or(default).

source

pub fn unwrap_or_else<F>(self, default: F) -> Instant
where F: FnOnce() -> Instant,

Returns the contained std::time::Instant or computes it from a closure.

instant.unwrap_or_else(default) is equivalent to instant.into_inner().unwrap_or_else(default).

Trait Implementations§

source§

impl Add<Duration> for Instant

§

type Output = Instant

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl Add<Duration> for Instant

§

type Output = Instant

The resulting type after applying the + operator.
source§

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

Performs the + operation. Read more
source§

impl AddAssign<Duration> for Instant

source§

fn add_assign(&mut self, other: Duration)

Performs the += operation. Read more
source§

impl AddAssign<Duration> for Instant

source§

fn add_assign(&mut self, other: Duration)

Performs the += operation. Read more
source§

impl Clone for Instant

source§

fn clone(&self) -> Instant

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Instant

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Instant> for Instant

source§

fn from(instant: Instant) -> Self

Converts to this type from the input type.
source§

impl From<Option<Instant>> for Instant

source§

fn from(dur: Option<Instant>) -> Self

Converts to this type from the input type.
source§

impl Hash for Instant

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Instant

source§

fn cmp(&self, other: &Instant) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<Instant> for Instant

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Instant> for Instant

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq for Instant

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd<Instant> for Instant

source§

fn partial_cmp(&self, other: &Instant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl PartialOrd<Instant> for Instant

source§

fn partial_cmp(&self, other: &Instant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl PartialOrd for Instant

source§

fn partial_cmp(&self, other: &Instant) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Sub<Duration> for Instant

§

type Output = Instant

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub<Duration> for Instant

§

type Output = Instant

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl Sub<Instant> for Instant

§

type Output = Duration

The resulting type after applying the - operator.
source§

fn sub(self, other: Instant) -> Self::Output

Performs the - operation. Read more
source§

impl Sub for Instant

§

type Output = Duration

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign<Duration> for Instant

source§

fn sub_assign(&mut self, other: Duration)

Performs the -= operation. Read more
source§

impl SubAssign<Duration> for Instant

source§

fn sub_assign(&mut self, other: Duration)

Performs the -= operation. Read more
source§

impl TryFrom<Instant> for Instant

§

type Error = TryFromTimeError

The type returned in the event of a conversion error.
source§

fn try_from(instant: Instant) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl Copy for Instant

source§

impl Eq for Instant

source§

impl StructuralPartialEq for Instant

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.