Struct time::Instant [−][src]
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 Duration
s, but is
otherwise identical to std::time::Instant
.
Implementations
impl Instant
[src]
pub fn now() -> Self
[src]
Returns an Instant
corresponding to “now”.
println!("{:?}", Instant::now());
pub fn elapsed(self) -> Duration
[src]
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<Self>
[src]
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()) );
This function is only present when using rustc >= 1.34.0.
pub fn checked_sub(self, duration: Duration) -> Option<Self>
[src]
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()) );
This function is only present when using rustc >= 1.34.0.
impl Instant
[src]
Trait Implementations
impl Add<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: Duration) -> Self::Output
[src]
impl Add<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, duration: StdDuration) -> Self::Output
[src]
impl AddAssign<Duration> for Instant
[src]
fn add_assign(&mut self, duration: Duration)
[src]
impl AddAssign<Duration> for Instant
[src]
fn add_assign(&mut self, duration: StdDuration)
[src]
impl Clone for Instant
[src]
impl Copy for Instant
[src]
impl Debug for Instant
[src]
impl Eq for Instant
[src]
impl From<Instant> for Instant
[src]
fn from(instant: StdInstant) -> Self
[src]
impl Hash for Instant
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Instant
[src]
fn cmp(&self, other: &Instant) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Instant> for Instant
[src]
impl PartialEq<Instant> for Instant
[src]
fn eq(&self, rhs: &StdInstant) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Instant> for Instant
[src]
fn partial_cmp(&self, other: &Instant) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl PartialOrd<Instant> for Instant
[src]
fn partial_cmp(&self, rhs: &StdInstant) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for Instant
[src]
impl StructuralPartialEq for Instant
[src]
impl Sub<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: Duration) -> Self::Output
[src]
impl Sub<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, duration: StdDuration) -> Self::Output
[src]
impl Sub<Instant> for Instant
[src]
type Output = Duration
The resulting type after applying the -
operator.
fn sub(self, other: Self) -> Self::Output
[src]
impl Sub<Instant> for Instant
[src]
type Output = Duration
The resulting type after applying the -
operator.
fn sub(self, other: StdInstant) -> Self::Output
[src]
impl SubAssign<Duration> for Instant
[src]
fn sub_assign(&mut self, duration: Duration)
[src]
impl SubAssign<Duration> for Instant
[src]
fn sub_assign(&mut self, duration: StdDuration)
[src]
Auto Trait Implementations
impl RefUnwindSafe for Instant
impl Send for Instant
impl Sync for Instant
impl Unpin for Instant
impl UnwindSafe for Instant
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Sealed<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,