Struct async_time_mock_core::TimerRegistry

pub struct TimerRegistry { /* private fields */ }

Implementations

impl TimerRegistry

pub fn sleep(
    &self,
    duration: Duration
) -> impl Future<Output = TimeHandlerGuard> + Send + Sync + 'static

Schedules a timer to expire in “Duration”, once expired, returns a TimeHandlerGuard that must be dropped only once the timer event has been fully processed (all sideeffects finished).

Roughly eqivalent to async pub fn sleep(&self, duration: Duration) -> TimeHandlerGuard.

pub fn sleep_until(
    &self,
    until: Instant
) -> impl Future<Output = TimeHandlerGuard> + Send + Sync + 'static

Schedules a timer to expire at “Instant”, once expired, returns a TimeHandlerGuard that must be dropped only once the timer event has been fully processed (all sideeffects finished).

Roughly eqivalent to async pub fn sleep_until(&self, until: Instant) -> TimeHandlerGuard.

Panics

When until was created by a different instance of TimerRegistry.

pub fn timeout<F>(&self, timeout: Duration, future: F) -> Timeout<F> where
    F: Future,

Combines a future with a sleep timer. If the future finishes before the timer has expired, returns the futures output. Otherwise returns Elapsed which contains a TimeHandlerGuard that must be dropped once the timeout has been fully processed (all sideeffects finished).

Roughly equivalent to async pub fn timeout<F: Future>(&self, timeout: Duration, future: F) -> Result<F::Output, Elapsed>

pub fn timeout_at<F>(&self, at: Instant, future: F) -> Timeout<F> where
    F: Future,

Combines a future with a sleep_until timer. If the future finishes before the timer has expired, returns the futures output. Otherwise returns Elapsed which contains a TimeHandlerGuard that must be dropped once the timeout has been fully processed (all sideeffects finished).

Roughly equivalent to async pub fn timeout_at<F: Future>(&self, at: Instant, future: F) -> Result<F::Output, Elapsed>

Panics

When at was created by a different instance of TimerRegistry.

pub fn interval(self: &Arc<Self>, period: Duration) -> Interval

pub fn interval_at(self: &Arc<Self>, start: Instant, period: Duration) -> Interval

pub async fn advance_time(&self, by_duration: Duration)

Advances test time by the given duration. Starts all scheduled timers that have expired at the new (advanced) point in time in the following order:

1. By time they are scheduled to run at
2. By the order they were scheduled

If no timer has been scheduled yet, waits until one is. Returns only once all started timers have finished processing.

pub fn now(&self) -> Instant

Current test time, increases on every call to [advance_time].

Trait Implementations

impl Debug for TimerRegistry

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

Formats the value using the given formatter.

impl Default for TimerRegistry

fn default() -> Self

Returns the “default value” for a type.