Struct cursive::reexports::time::Instant [−]
#[repr(transparent)]pub struct Instant(pub Instant);
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 Duration
s, but is otherwise identical
to std::time::Instant
.
Tuple Fields
0: Instant
Implementations
impl Instant
impl Instant
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>
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>
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
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
pub fn add_assign(&mut self, rhs: Duration)
pub fn add_assign(&mut self, rhs: Duration)
Performs the +=
operation. Read more
pub fn add_assign(&mut self, rhs: Duration)
pub fn add_assign(&mut self, rhs: Duration)
Performs the +=
operation. Read more
impl PartialOrd<Instant> for Instant
impl PartialOrd<Instant> for Instant
pub fn partial_cmp(&self, rhs: &Instant) -> Option<Ordering>
pub fn partial_cmp(&self, rhs: &Instant) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl PartialOrd<Instant> for Instant
impl PartialOrd<Instant> for Instant
pub fn partial_cmp(&self, other: &Instant) -> Option<Ordering>
pub fn partial_cmp(&self, other: &Instant) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl PartialOrd<Instant> for Instant
impl PartialOrd<Instant> for Instant
pub fn partial_cmp(&self, rhs: &Instant) -> Option<Ordering>
pub fn partial_cmp(&self, rhs: &Instant) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
pub fn sub_assign(&mut self, rhs: Duration)
pub fn sub_assign(&mut self, rhs: Duration)
Performs the -=
operation. Read more
pub fn sub_assign(&mut self, rhs: Duration)
pub fn sub_assign(&mut self, rhs: Duration)
Performs the -=
operation. Read more
impl StructuralEq for Instant
impl StructuralPartialEq for Instant
Auto Trait Implementations
impl RefUnwindSafe for Instant
impl UnwindSafe for Instant
Blanket Implementations
Mutably borrows from an owned value. Read more
Calls the given closure and return the result. Read more
Calls the given closure on self
.