Trait Instant

pub trait Instant:
    Copy
    + Debug
    + Sized {
    // Required methods
    fn now() -> Self;
    fn checked_add(&self, duration: Duration) -> Option<Self>;
    fn checked_sub(&self, duration: Duration) -> Option<Self>;
    fn saturating_duration_since(&self, earlier: Self) -> Duration;
}

A trait outlining the behavior of a timekeeping type.

This trait allows libsw to be agnostic about timekeeping: any type which implements Instant can be used within a Stopwatch.

Provided implementations

libsw_core provides Instant implementations for timekeeping types in the standard library.

Type	Feature flag	Notes
std::time::Instant	std
std::time::SystemTime	std
tokio::time::Instant	tokio
coarsetime::Instant	coarsetime
quanta::Instant	quanta
time::Instant	time	Deprecated.

If a timekeeping type you want to use isn’t supported out of the box, please consider filing an issue on GitHub. If you already implemented Instant for it, consider sending a PR upstream.

Required Methods

fn now() -> Self

Returns the current instant in time.

fn checked_add(&self, duration: Duration) -> Option<Self>

Returns an instant ahead of self by the given Duration of time.

Returns None if overflow occured, meaning the new instant was not representable with the underlying type.

fn checked_sub(&self, duration: Duration) -> Option<Self>

Returns an instant previous to self by the given Duration of time.

Returns None if overflow occured, meaning the new instant was not representable with the underlying type.

fn saturating_duration_since(&self, earlier: Self) -> Duration

Returns the Duration that has elapsed since earlier, returning Duration::ZERO if earlier is ahead of self.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Instant for Instant

Available on crate feature std only.

fn now() -> Self

fn checked_add(&self, duration: Duration) -> Option<Self>

fn checked_sub(&self, duration: Duration) -> Option<Self>

fn saturating_duration_since(&self, earlier: Self) -> Duration

impl Instant for SystemTime

Available on crate feature std only.

fn now() -> Self

fn checked_add(&self, duration: Duration) -> Option<Self>

fn checked_sub(&self, duration: Duration) -> Option<Self>

fn saturating_duration_since(&self, earlier: Self) -> Duration

impl Instant for Instant

Available on crate feature coarsetime only.

fn now() -> Self

fn checked_add(&self, duration: Duration) -> Option<Self>

fn checked_sub(&self, duration: Duration) -> Option<Self>

fn saturating_duration_since(&self, earlier: Self) -> Duration

impl Instant for Instant

Available on crate feature quanta only.

fn now() -> Self

fn checked_add(&self, duration: Duration) -> Option<Self>

fn checked_sub(&self, duration: Duration) -> Option<Self>

fn saturating_duration_since(&self, earlier: Self) -> Duration

impl Instant for Instant

Available on crate feature tokio only.

fn now() -> Self

fn checked_add(&self, duration: Duration) -> Option<Self>

fn checked_sub(&self, duration: Duration) -> Option<Self>

fn saturating_duration_since(&self, earlier: Self) -> Duration

Implementors