Struct quanta::Instant

pub struct Instant(_);

A point-in-time wall-clock measurement.

Represents a time measurement that has been taken by Clock and scaled to reference time, which is relative to the Unix epoch of 1970-01-01T00:00:00Z.

Unlike the stdlib Instant, this type has a meaningful difference: it is intended to be opaque, but the internal value can be accessed. There are no guarantees here and depending on this value directly is proceeding at your own risk. ⚠️

An Instant is 8 bytes.

Implementations

impl Instant

pub fn now() -> Instant

Gets the current time, scaled to reference time.

This method depends on a lazily initialized global clock, which can take up to 200ms to initialize and calibrate itself.

This method is the spiritual equivalent of std::time::Instant::now. It is guaranteed to return a monotonically increasing value.

pub fn recent() -> Instant

Gets the most recent current time, scaled to reference time.

This method provides ultra-low-overhead access to a slightly-delayed version of the current time. Instead of querying the underlying source clock directly, a shared, global value is read directly without the need to scale to reference time.

The value is updated by running an "upkeep" thread or by calling [quanta::set_recent]. An upkeep thread can be configured and spawned via [Builder].

If the upkeep thread has not been started, or no value has been set manually, a lazily initialized global clock will be used to get the current time. This clock can take up to 200ms to initialize and calibrate itself.

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

Returns the amount of time elapsed from another instant to this one.

Panics

This function will panic if earlier is later than self.

Examples

use quanta::Clock;
use std::time::Duration;
use std::thread::sleep;

let mut clock = Clock::new();
let now = clock.now();
sleep(Duration::new(1, 0));
let new_now = clock.now();
println!("{:?}", new_now.duration_since(now));

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

Returns the amount of time elapsed from another instant to this one, or None if that instant is earlier than this one.

Examples

use quanta::Clock;
use std::time::Duration;
use std::thread::sleep;

let mut clock = Clock::new();
let now = clock.now();
sleep(Duration::new(1, 0));
let new_now = clock.now();
println!("{:?}", new_now.checked_duration_since(now));
println!("{:?}", now.checked_duration_since(new_now)); // None

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

Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is earlier than this one.

Examples

use quanta::Clock;
use std::time::Duration;
use std::thread::sleep;

let mut clock = Clock::new();
let now = clock.now();
sleep(Duration::new(1, 0));
let new_now = clock.now();
println!("{:?}", new_now.saturating_duration_since(now));
println!("{:?}", now.saturating_duration_since(new_now)); // 0ns

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

Returns Some(t) where t is the time self + duration if t can be represented as Instant (which means it's inside the bounds of the underlying data structure), None otherwise.

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

Returns Some(t) where t is the time self - duration if t can be represented as Instant (which means it's inside the bounds of the underlying data structure), None otherwise.

pub fn as_unix_duration(&self) -> Duration

Gets this Instant as a Duration since the Unix epoch.

pub fn as_u64(&self) -> u64

Gets the inner value of this Instant.

Trait Implementations

impl Add<Duration> for Instant

type Output = Instant

The resulting type after applying the + operator.

pub fn add(self, other: Duration) -> Instant

Panics

This function may panic if the resulting point in time cannot be represented by the underlying data structure. See Instant::checked_add for a version without panic.

impl AddAssign<Duration> for Instant

pub fn add_assign(&mut self, other: Duration)

Performs the += operation.

impl AsNanoseconds for Instant

pub fn as_nanos(&self) -> u64

Performs the conversion.

impl Clone for Instant

pub fn clone(&self) -> Instant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Instant

impl Debug for Instant

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

Formats the value using the given formatter.

impl Eq for Instant

impl Into<Timestamp> for Instant

pub fn into(self) -> Timestamp

Performs the conversion.

impl Ord for Instant

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Instant> for Instant

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

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

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

This method tests for !=.

impl PartialOrd<Instant> for Instant

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Instant

impl StructuralPartialEq for Instant

impl Sub<Duration> for Instant

type Output = Instant

The resulting type after applying the - operator.

pub fn sub(self, other: Duration) -> Instant

Performs the - operation.

impl Sub<Instant> for Instant

type Output = Duration

The resulting type after applying the - operator.

pub fn sub(self, other: Instant) -> Duration

Performs the - operation.

impl SubAssign<Duration> for Instant

pub fn sub_assign(&mut self, other: Duration)

Performs the -= operation.