Struct easytime::Instant [−][src]
std
only.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.
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 fails and returns None
on macOS:
use easytime::{Duration, Instant}; let now = Instant::now(); let max_nanoseconds = u64::MAX / 1_000_000_000; let duration = Duration::new(max_nanoseconds, 0); // Unlike `std::time::Instant`, it won't panic! let result = now + duration; #[cfg(target_os = "linux")] assert!(result.is_some()); #[cfg(target_os = "macos")] assert!(result.is_none());
Underlying System calls
See the standard library documentation
for the system calls used to get the current time using now()
.
Implementations
impl Instant
[src]
pub fn now() -> Self
[src]
Returns an instant corresponding to “now”.
Examples
use easytime::Instant; let now = Instant::now();
pub fn duration_since(&self, earlier: Self) -> Duration
[src]
Returns the amount of time elapsed from another instant to this one.
Examples
use std::{thread::sleep, time}; use easytime::Instant; let now = Instant::now(); sleep(time::Duration::new(1, 0)); let new_now = Instant::now(); println!("{:?}", new_now.duration_since(now));
pub fn elapsed(&self) -> Duration
[src]
Returns the amount of time elapsed since this instant was created.
Examples
use std::{thread::sleep, time}; use easytime::Instant; let instant = Instant::now(); let three_secs = time::Duration::from_secs(3); sleep(three_secs); assert!(instant.elapsed() >= three_secs);
pub const fn is_some(&self) -> bool
[src]
Returns true
if into_inner
returns Some
.
pub const fn is_none(&self) -> bool
[src]
Returns true
if into_inner
returns None
.
pub const fn into_inner(self) -> Option<Instant>
[src]
Returns the contained std::time::Instant
or None
.
pub const fn unwrap_or(self, default: Instant) -> Instant
[src]
Returns the contained std::time::Instant
or a default.
instant.unwrap_or(default)
is equivalent to instant.into_inner().unwrap_or(default)
.
pub fn unwrap_or_else<F>(self, default: F) -> Instant where
F: FnOnce() -> Instant,
[src]
F: FnOnce() -> Instant,
Returns the contained std::time::Instant
or computes it from a closure.
instant.unwrap_or_else(default)
is equivalent to instant.into_inner().unwrap_or_else(default)
.
Trait Implementations
impl Add<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, other: Duration) -> Self::Output
[src]
impl Add<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, other: Duration) -> Self::Output
[src]
impl AddAssign<Duration> for Instant
[src]
fn add_assign(&mut self, other: Duration)
[src]
impl AddAssign<Duration> for Instant
[src]
fn add_assign(&mut self, other: Duration)
[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]
impl From<Option<Instant>> for Instant
[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, other: &Instant) -> 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, 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 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, other: Duration) -> Self::Output
[src]
impl Sub<Duration> for Instant
[src]
type Output = Self
The resulting type after applying the -
operator.
fn sub(self, other: Duration) -> 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: Instant) -> Self::Output
[src]
impl SubAssign<Duration> for Instant
[src]
fn sub_assign(&mut self, other: Duration)
[src]
impl SubAssign<Duration> for Instant
[src]
fn sub_assign(&mut self, other: Duration)
[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> 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>,