Struct FakeTimerCtx

pub struct FakeTimerCtx<Id> {
    pub instant: FakeInstantCtx,
    pub timers: BinaryHeap<InstantAndData<FakeTimer<Id>>>,
    /* private fields */
}

A fake TimerContext which stores time as a FakeInstantCtx.

Fields

instant: FakeInstantCtx

The instant context within this fake timer context.

timers: BinaryHeap<InstantAndData<FakeTimer<Id>>>

The timer heap kept by the fake implementation.

Implementations

impl<Id: Clone> FakeTimerCtx<Id>

pub fn timers(&self) -> Vec<(FakeInstant, Id)>

Get an ordered list of all currently-scheduled timers.

impl<Id: Debug + Clone + Hash + Eq> FakeTimerCtx<Id>

pub fn assert_timers_installed<I: IntoIterator<Item = (Id, FakeInstant)>>( &self, timers: I, )

Asserts that self contains exactly the timers in timers.

Panics

Panics if timers contains the same ID more than once or if self does not contain exactly the timers in timers.

pub fn assert_timers_installed_range<R: RangeBounds<FakeInstant> + Debug, I: IntoIterator<Item = (Id, R)>>( &self, timers: I, )

Like [assert_timers_installed] but receives a range instants to match.

Each timer must be present, and its deadline must fall into the specified range.

pub fn assert_some_timers_installed<I: IntoIterator<Item = (Id, FakeInstant)>>( &self, timers: I, )

Asserts that self contains at least the timers in timers.

Like [assert_timers_installed], but only asserts that timers is a subset of the timers installed; other timers may be installed in addition to those in timers.

pub fn assert_some_timers_installed_range<R: RangeBounds<FakeInstant> + Debug, I: IntoIterator<Item = (Id, R)>>( &self, timers: I, )

Like [assert_some_timers_installed] but receives instant ranges to match like [assert_timers_installed_range].

pub fn assert_no_timers_installed(&self)

Asserts that no timers are installed.

Panics

Panics if any timers are installed.

Trait Implementations

impl<Id> Default for FakeTimerCtx<Id>

fn default() -> FakeTimerCtx<Id>

Returns the “default value” for a type.

impl<Id> InstantBindingsTypes for FakeTimerCtx<Id>

type Instant = FakeInstant

The type of an instant in time.

type AtomicInstant = FakeAtomicInstant

An atomic representation of Self::Instant.

impl<Id> InstantContext for FakeTimerCtx<Id>

fn now(&self) -> FakeInstant

Returns the current instant.

fn now_atomic(&self) -> Self::AtomicInstant

Returns the current instant, as an [Self::AtomicInstant].

impl<Id: Debug + Clone + Send + Sync> TimerBindingsTypes for FakeTimerCtx<Id>

type Timer = FakeTimer<Id>

State for a timer created through TimerContext.

type DispatchId = Id

The type used to dispatch fired timers from bindings to core.

type UniqueTimerId = FakeTimerId

A value that uniquely identifiers a Timer. It is given along with the DispatchId whenever a timer is fired.

impl<Id: PartialEq + Debug + Clone + Send + Sync> TimerContext for FakeTimerCtx<Id>

fn new_timer(&mut self, dispatch_id: Self::DispatchId) -> Self::Timer

Creates a new timer that dispatches id back to core when fired.

fn schedule_timer_instant( &mut self, time: Self::Instant, timer: &mut Self::Timer, ) -> Option<Self::Instant>

Schedule a timer to fire at some point in the future. Returns the previously scheduled instant, if this timer was scheduled.

fn cancel_timer(&mut self, timer: &mut Self::Timer) -> Option<Self::Instant>

Cancel a timer.

fn scheduled_instant(&self, timer: &mut Self::Timer) -> Option<Self::Instant>

Get the instant a timer will fire, if one is scheduled.

fn unique_timer_id(&self, timer: &Self::Timer) -> Self::UniqueTimerId

Retrieves the timer id for timer.

fn schedule_timer( &mut self, duration: Duration, timer: &mut Self::Timer, ) -> Option<Self::Instant>

Like [schedule_timer_instant] but schedules a time for duration in the future.

impl<TimerId> WithFakeTimerContext<TimerId> for FakeTimerCtx<TimerId>

fn with_fake_timer_ctx<O, F: FnOnce(&FakeTimerCtx<TimerId>) -> O>( &self, f: F, ) -> O

Calls the callback with a borrow of FakeTimerCtx.

fn with_fake_timer_ctx_mut<O, F: FnOnce(&mut FakeTimerCtx<TimerId>) -> O>( &mut self, f: F, ) -> O

Calls the callback with a mutable borrow of FakeTimerCtx.