Struct Instant
pub struct Instant(pub(in ::time) Instant);
A measurement of a monotonically nondecreasing clock.
Opaque and useful only with Duration.
Instants are always guaranteed, barring platform bugs, 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 might 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. As part of this non-guarantee it is also not specified whether system suspends count as elapsed time or not. The behavior varies across platforms and Rust versions.
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.
Example:
use std::time::{Duration, Instant};
use std::thread::sleep;
fn main() {
let now = Instant::now();
// we sleep for 2 seconds
sleep(Duration::new(2, 0));
// it prints '2'
println!("{}", now.elapsed().as_secs());
}
OS-specific behaviors
An Instant is a wrapper around system-specific types and it may behave
differently depending on the underlying operating system. For example,
the following snippet is fine on Linux but panics on macOS:
use std::time::{Instant, Duration};
let now = Instant::now();
let days_per_10_millennia = 365_2425;
let solar_seconds_per_day = 60 * 60 * 24;
let millennium_in_solar_seconds = 31_556_952_000;
assert_eq!(millennium_in_solar_seconds, days_per_10_millennia * solar_seconds_per_day / 10);
let duration = Duration::new(millennium_in_solar_seconds, 0);
println!("{:?}", now + duration);
For cross-platform code, you can comfortably use durations of up to around one hundred years.
Underlying System calls
The following system calls are currently being used by now() to find out
the current time:
| Platform | System call |
|---|---|
| SGX | insecure_time usercall. More information on timekeeping in SGX |
| UNIX | clock_gettime with CLOCK_MONOTONIC |
| WASI | clock_gettime with CLOCK_MONOTONIC |
| Darwin | clock_gettime with CLOCK_UPTIME_RAW |
| VXWorks | clock_gettime with CLOCK_MONOTONIC |
| SOLID | get_tim |
| Windows | QueryPerformanceCounter |
Disclaimer: These system calls might change over time.
Note: mathematical operations like
addmay panic if the underlying structure cannot represent the new point in time.
Monotonicity
On all platforms Instant will try to use an OS API that guarantees monotonic behavior
if available, which is the case for all tier 1 platforms.
In practice such guarantees are – under rare circumstances – broken by hardware, virtualization
or operating system bugs. To work around these bugs and platforms not offering monotonic clocks
duration_since, elapsed and sub saturate to zero. In older
Rust versions this lead to a panic instead. checked_duration_since can be used to detect and
handle situations where monotonicity is violated, or Instants are subtracted in the wrong order.
This workaround obscures programming errors where earlier and later instants are accidentally swapped. For this reason future Rust versions may reintroduce panics.
Fields
0: Instant
Implementations
impl Instant
fn now() -> InstantReturns an instant corresponding to "now".
Examples
use Instant; let now = now;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.
Panics
Previous Rust versions panicked when
earlierwas later thanself. Currently this method saturates. Future versions may reintroduce the panic in some circumstances. See Monotonicity.Examples
use std::time::{Duration, Instant}; use std::thread::sleep; let now = Instant::now(); sleep(Duration::new(1, 0)); let new_now = Instant::now(); println!("{:?}", new_now.duration_since(now)); println!("{:?}", now.duration_since(new_now)); // 0nsfn 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.
Due to monotonicity bugs, even under correct logical ordering of the passed
Instants, this method can returnNone.Examples
use std::time::{Duration, Instant}; use std::thread::sleep; let now = Instant::now(); sleep(Duration::new(1, 0)); let new_now = Instant::now(); println!("{:?}", new_now.checked_duration_since(now)); println!("{:?}", now.checked_duration_since(new_now)); // Nonefn 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 std::time::{Duration, Instant}; use std::thread::sleep; let now = Instant::now(); sleep(Duration::new(1, 0)); let new_now = Instant::now(); println!("{:?}", new_now.saturating_duration_since(now)); println!("{:?}", now.saturating_duration_since(new_now)); // 0nsfn elapsed(&self) -> DurationReturns the amount of time elapsed since this instant.
Panics
Previous Rust versions panicked when the current time was earlier than self. Currently this method returns a Duration of zero in that case. Future versions may reintroduce the panic. See Monotonicity.
Examples
use std::thread::sleep; use std::time::{Duration, Instant}; let instant = Instant::now(); let three_secs = Duration::from_secs(3); sleep(three_secs); assert!(instant.elapsed() >= three_secs);fn 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.fn into_inner(self) -> Instant
Trait Implementations
impl Add<Duration> for Instant
type Output = Instant;fn add(self, other: Duration) -> InstantPanics
This function may panic if the resulting point in time cannot be represented by the underlying data structure. See
Instant::checked_addfor a version without panic.
impl AddAssign<Duration> for Instant
fn add_assign(&mut self, other: Duration)
impl Clone for Instant
fn clone(&self) -> Instant
impl Copy for Instant
impl Debug for Instant
fn fmt(&self, f: &mut Formatter<'_>) -> Result
impl Eq for Instant
fn assert_fields_are_eq(&self)
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, other: Instant) -> DurationReturns the amount of time elapsed from another instant to this one, or zero duration if that instant is later than this one.
Panics
Previous Rust versions panicked when
otherwas later thanself. Currently this method saturates. Future versions may reintroduce the panic in some circumstances. See Monotonicity.
impl Sub<Duration> for Instant
type Output = Instant;fn sub(self, other: Duration) -> Instant
impl SubAssign<Duration> for Instant
fn sub_assign(&mut self, other: Duration)
impl TrivialClone for Instant
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> Printable for Instant
where
T: Copy + Debug,
impl<T> SizeHint for Instant
where
T: ?Sized,
fn lower_bound(&self) -> usizefn upper_bound(&self) -> Option<usize>
impl<T> SizedTypeProperties for Instant
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 = Infallible;fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
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>