Struct spa_server::re_export::rt::time::Instant [−]
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
pub fn now() -> Instant
Returns an instant corresponding to “now”.
Examples
use tokio::time::Instant; let now = Instant::now();
pub fn from_std(std: Instant) -> Instant
Create a tokio::time::Instant
from a std::time::Instant
.
pub fn into_std(self) -> Instant
Convert the value into a std::time::Instant
.
pub fn duration_since(&self, earlier: Instant) -> Duration
Returns the amount of time elapsed from another instant to this one.
Panics
This function will panic if earlier
is later than self
.
pub 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 tokio::time::{Duration, Instant, sleep}; #[tokio::main] async fn main() { let now = Instant::now(); sleep(Duration::new(1, 0)).await; let new_now = Instant::now(); println!("{:?}", new_now.checked_duration_since(now)); println!("{:?}", now.checked_duration_since(new_now)); // None }
pub fn saturating_duration_since(&self, earlier: Instant) -> Duration
Returns the amount of time elapsed from another instant to this one, or zero duration if that instant is earlier than this one.
Examples
use tokio::time::{Duration, Instant, sleep}; #[tokio::main] async fn main() { let now = Instant::now(); sleep(Duration::new(1, 0)).await; let new_now = Instant::now(); println!("{:?}", new_now.saturating_duration_since(now)); println!("{:?}", now.saturating_duration_since(new_now)); // 0ns }
pub fn elapsed(&self) -> Duration
Returns the amount of time elapsed since this instant was created.
Panics
This function may panic if the current time is earlier than this
instant, which is something that can happen if an Instant
is
produced synthetically.
Examples
use tokio::time::{Duration, Instant, sleep}; #[tokio::main] async fn main() { let instant = Instant::now(); let three_secs = Duration::from_secs(3); sleep(three_secs).await; assert!(instant.elapsed() >= three_secs); }
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.
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.
Trait Implementations
impl Add<Duration> for Instant
type Output = Instant
The resulting type after applying the +
operator.
pub fn add(self, other: Duration) -> Instant
impl AddAssign<Duration> for Instant
pub fn add_assign(&mut self, rhs: Duration)
impl Clone for Instant
pub fn clone(&self) -> Instant
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for Instant
impl Debug for Instant
impl Eq for Instant
impl From<Instant> for Instant
impl Hash for Instant
pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
__H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Instant
pub fn cmp(&self, other: &Instant) -> Ordering
#[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
impl PartialOrd<Instant> for Instant
pub fn partial_cmp(&self, other: &Instant) -> Option<Ordering>
#[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
impl StructuralPartialEq for Instant
impl Sub<Duration> for Instant
type Output = Instant
The resulting type after applying the -
operator.
pub fn sub(self, rhs: Duration) -> Instant
impl Sub<Instant> for Instant
type Output = Duration
The resulting type after applying the -
operator.
pub fn sub(self, rhs: Instant) -> Duration
impl SubAssign<Duration> for Instant
pub fn sub_assign(&mut self, rhs: Duration)
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> CallHasher for T where
T: Hash + ?Sized,
T: Hash + ?Sized,
pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
B: BuildHasher,
H: Hash + ?Sized,
B: BuildHasher,
H: Hash + ?Sized,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,