Struct FixedClock 

pub struct FixedClock { /* private fields */ }

A clock that returns the instant supplied by a test until it is set again.

Implementations

impl FixedClock

pub fn new(now: SystemTime) -> Self

A clock initially set to now.

pub fn set(&self, now: SystemTime)

Set the time every subsequent read returns, including a backward jump.

pub fn sleeps_begun(&self) -> u64

How many deadlines and waits have begun on this clock so far.

pub fn sleep_begun_after( &self, seen: u64, ) -> impl Future<Output = (u64, Duration)> + Send + 'static

Wait until a deadline or wait begins after the first seen, and return how many have begun and the latest one’s end by elapsed, so a test can set the clock to exactly the wait the code armed.

Trait Implementations

impl Clock for FixedClock

Available on crate feature test-utils only.

fn elapsed(&self) -> Duration

Forward settings advance it, as sleep would; backward ones do not.

fn sleep_until( &self, at: SystemTime, ) -> Pin<Box<dyn Future<Output = Result<(), WallTimerError>> + Send>>

Wakes when a setting reaches at; one before it, forward or back, does not.

fn now(&self) -> SystemTime

The wall clock’s current time.

fn deadline( &self, duration: Duration, ) -> Pin<Box<dyn Future<Output = ()> + Send>>

End once duration of elapsed time has passed: a deadline that work races, such as a sign-in’s wait for its callback or a stalled transfer’s, or an interval, such as the idle time between passes. System clocks use the runtime’s monotonic timer; controlled clocks wake only when their supplied time advances.

fn wait_out(&self, wait: Duration) -> Pin<Box<dyn Future<Output = ()> + Send>>

Wait out wait before trying again: a backoff, a provider’s cooldown, or the spacing between requests the code chose. It passes as a deadline of the same length does; a test’s clock may move its time to the wait’s end as the code arms it, since no work races it.