Struct Instant
pub struct Instant { /* private fields */ }
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.
Note
This type wraps the inner std variant and is used to align the Tokio
clock for uses of now(). This can be useful for testing where you can
take advantage of time::pause() and time::advance().
Implementations
impl Instant
fn now() -> InstantReturns an instant corresponding to "now".
Examples
use Instant; let now = now;fn from_std(std: Instant) -> InstantCreate a
tokio::time::Instantfrom astd::time::Instant.fn into_std(self) -> InstantConvert the value into a
std::time::Instant.fn duration_since(&self, earlier: Instant) -> DurationReturns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.
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 later than this one.
Examples
use ; # # asyncfn saturating_duration_since(&self, earlier: Instant) -> DurationReturns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.
Examples
use ; # # asyncfn elapsed(&self) -> DurationReturns the amount of time elapsed since this instant was created, or zero duration if this instant is in the future.
Examples
use ; # # asyncfn checked_add(&self, duration: Duration) -> Option<Instant>Returns
Some(t)wheretis the timeself + durationiftcan be represented asInstant(which means it's inside the bounds of the underlying data structure),Noneotherwise.fn checked_sub(&self, duration: Duration) -> Option<Instant>Returns
Some(t)wheretis the timeself - durationiftcan be represented asInstant(which means it's inside the bounds of the underlying data structure),Noneotherwise.
Trait Implementations
impl Add<Duration> for Instant
type Output = Instant;fn add(self, other: Duration) -> Instant
impl AddAssign<Duration> for Instant
fn add_assign(&mut self, rhs: Duration)
impl Clone for Instant
fn clone(&self) -> Instant
impl Copy for Instant
impl Debug for Instant
fn fmt(&self, fmt: &mut Formatter<'_>) -> Result
impl Eq for Instant
impl From<Instant> for Instant
fn from(time: Instant) -> Instant
impl Hash for Instant
fn hash<__H: Hasher>(&self, state: &mut __H)
impl Ord for Instant
fn cmp(&self, other: &Instant) -> Ordering
impl PartialEq for Instant
fn eq(&self, other: &Instant) -> bool
impl PartialOrd for Instant
fn partial_cmp(&self, other: &Instant) -> Option<Ordering>
impl StructuralPartialEq for Instant
impl Sub for Instant
type Output = Duration;fn sub(self, rhs: Instant) -> Duration
impl Sub<Duration> for Instant
type Output = Instant;fn sub(self, rhs: Duration) -> Instant
impl SubAssign<Duration> for Instant
fn sub_assign(&mut self, rhs: Duration)
Auto Trait Implementations
impl Freeze for Instant
impl RefUnwindSafe for Instant
impl Send for Instant
impl Sync for Instant
impl Unpin for Instant
impl UnsafeUnpin for Instant
impl UnwindSafe for Instant
Blanket Implementations
impl<T> Any for Instant
where
T: 'static + ?Sized,
fn type_id(&self) -> TypeId
impl<T> Borrow<T> for Instant
where
T: ?Sized,
fn borrow(&self) -> &T
impl<T> BorrowMut<T> for Instant
where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
impl<T> CloneToUninit for Instant
where
T: Clone,
unsafe fn clone_to_uninit(&self, dest: *mut u8)
impl<T> From<T> for Instant
fn from(t: T) -> TReturns the argument unchanged.
impl<T> ToOwned for Instant
where
T: Clone,
type Owned = T;fn to_owned(&self) -> Tfn clone_into(&self, target: &mut T)
impl<T, U> Into<U> for Instant
where
U: From<T>,
fn into(self) -> UCalls
U::from(self).That is, this conversion is whatever the implementation of
[From]<T> for Uchooses to do.
impl<T, U> TryFrom<U> for Instant
where
U: Into<T>,
type Error = never;fn try_from(value: U) -> Result<T, never>
impl<T, U> TryInto<U> for Instant
where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error;fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>