Struct Clock 

pub struct Clock { /* private fields */ }

A monotonic clock, either the real one or a paused one that a test advances by hand.

Clones share one clock. Equality is identity, not the current time, so all real clocks are equal and a paused clock equals only its own clones.

Implementations

impl Clock

pub fn paused() -> Self

Available on crate feature test-clock only.

Creates a paused clock, set to the current real time. It moves only when Clock::advance or Clock::advance_to moves it.

pub fn advance(&self, by: Duration)

Available on crate feature test-clock only.

Moves a paused clock forward by by and wakes all its waiters. It returns once they are notified, without waiting for them to act. A zero step does nothing.

Panics

Panics on a real clock, or if the new time overflows Instant. The time is unchanged after a panic.

pub fn advance_to(&self, target: Instant)

Available on crate feature test-clock only.

Moves a paused clock forward to target and wakes all its waiters. It returns once they are notified, without waiting for them to act. Advancing to the current time does nothing.

Panics

Panics on a real clock, or if target is earlier than the current time. The time is unchanged after a panic.

impl Clock

pub fn real() -> Self

Returns the real monotonic clock, which reads Instant::now.

pub fn now(&self) -> Instant

Returns the clock’s current time.

pub fn waiter(&self) -> Waiter

Creates a waiter that measures deadlines on this clock. A paused clock wakes it on every advance.

Trait Implementations

impl Clone for Clock

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Clock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Shows whether the clock is paused and, if so, how far it has advanced.

impl Eq for Clock

Available on crate features test-clock only.

impl PartialEq for Clock

Available on crate features test-clock only.

fn eq(&self, other: &Self) -> bool

Compares identity. Real clocks are all equal; a paused clock equals only its own clones.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.