Struct pavex::time::Instant

#[repr(transparent)]
pub struct Instant(pub Instant);
๐Ÿ‘ŽDeprecated since 0.3.35: import time::ext::InstantExt instead
Expand description

A measurement of a monotonically non-decreasing 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).

This implementation allows for operations with signed Durations, but is otherwise identical to std::time::Instant.

Tuple Fieldsยง

ยง0: Instant
๐Ÿ‘ŽDeprecated since 0.3.35: import time::ext::InstantExt instead

Implementationsยง

ยง

impl Instant

pub fn now() -> Instant

Returns an Instant corresponding to โ€œnowโ€.

println!("{:?}", Instant::now());

pub fn elapsed(self) -> Duration

Returns the amount of time elapsed since this instant was created. The duration will always be nonnegative if the instant is not synthetically created.

let instant = Instant::now();
thread::sleep(1.std_milliseconds());
assert!(instant.elapsed() >= 1.milliseconds());

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.

let now = Instant::now();
assert_eq!(now.checked_add(5.seconds()), Some(now + 5.seconds()));
assert_eq!(now.checked_add((-5).seconds()), Some(now + (-5).seconds()));

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.

let now = Instant::now();
assert_eq!(now.checked_sub(5.seconds()), Some(now - 5.seconds()));
assert_eq!(now.checked_sub((-5).seconds()), Some(now - (-5).seconds()));

pub const fn into_inner(self) -> Instant

Obtain the inner std::time::Instant.

let now = Instant::now();
assert_eq!(now.into_inner(), now.0);

Trait Implementationsยง

ยง

impl Add<Duration> for Instant

ยง

fn add(self, duration: Duration) -> <Instant as Add<Duration>>::Output

ยงPanics

This function may panic if the resulting point in time cannot be represented by the underlying data structure.

ยง

type Output = Instant

The resulting type after applying the + operator.
ยง

impl Add<Duration> for Instant

ยง

type Output = Instant

The resulting type after applying the + operator.
ยง

fn add(self, duration: Duration) -> <Instant as Add<Duration>>::Output

Performs the + operation. Read more
ยง

impl AddAssign<Duration> for Instant

ยง

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more
ยง

impl AddAssign<Duration> for Instant

ยง

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more
ยง

impl AsRef<Instant> for Instant

ยง

fn as_ref(&self) -> &Instant

Converts this type into a shared reference of the (usually inferred) input type.
ยง

impl Borrow<Instant> for Instant

ยง

fn borrow(&self) -> &Instant

Immutably borrows from an owned value. Read more
ยง

impl Clone for Instant

ยง

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
ยง

impl Debug for Instant

ยง

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

Formats the value using the given formatter. Read more
ยง

impl From<Instant> for Instant

ยง

fn from(instant: Instant) -> Instant

Converts to this type from the input type.
ยง

impl Hash for Instant

ยง

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

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
ยง

impl Ord for Instant

ยง

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
ยง

impl PartialEq<Instant> for Instant

ยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท sourceยง

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

ยง

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 ยท sourceยง

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

ยง

fn partial_cmp(&self, rhs: &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

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

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

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
ยง

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. Read more
1.0.0 ยท sourceยง

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

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

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

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
ยง

impl Sub<Duration> for Instant

ยง

fn sub(self, duration: Duration) -> <Instant as Sub<Duration>>::Output

ยงPanics

This function may panic if the resulting point in time cannot be represented by the underlying data structure.

ยง

type Output = Instant

The resulting type after applying the - operator.
ยง

impl Sub<Duration> for Instant

ยง

fn sub(self, duration: Duration) -> <Instant as Sub<Duration>>::Output

ยงPanics

This function may panic if the resulting point in time cannot be represented by the underlying data structure.

ยง

type Output = Instant

The resulting type after applying the - operator.
ยง

impl Sub<Instant> for Instant

ยง

type Output = Duration

The resulting type after applying the - operator.
ยง

fn sub(self, other: Instant) -> <Instant as Sub<Instant>>::Output

Performs the - operation. Read more
ยง

impl Sub for Instant

ยง

fn sub(self, other: Instant) -> <Instant as Sub>::Output

ยงPanics

This may panic if an overflow occurs.

ยง

type Output = Duration

The resulting type after applying the - operator.
ยง

impl SubAssign<Duration> for Instant

ยง

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more
ยง

impl SubAssign<Duration> for Instant

ยง

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more
ยง

impl Copy for Instant

ยง

impl Eq for Instant

ยง

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> CloneToUninit for T
where T: Clone,

sourceยง

unsafe fn clone_to_uninit(&self, dst: *mut T)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
ยง

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

ยง

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
ยง

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

ยง

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
ยง

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

ยง

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
sourceยง

impl<T> From<T> for T

sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

ยง

impl<T> Instrument for T

ยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
ยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

sourceยง

type Output = T

Should always be Self
sourceยง

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

sourceยง

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

sourceยง

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

sourceยง

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.
ยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

ยง

fn vzip(self) -> V

ยง

impl<T> WithSubscriber for T

ยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
ยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more