Struct State

struct State {
    core: MockTimeCore,
    futures: DenseSlotMap<DefaultKey, Option<Waker>>,
    unready: PriorityQueue<DefaultKey, Reverse<Instant>>,
}

Mutable state for a Provider

Each sleep (Id, SleepFuture) is in one of the following states:

state	SleepFuture	futures	unready
UNPOLLLED	exists	present, None	present, > now
WAITING	exists	present, Some	present, > now
READY	exists	present, None	absent
DROPPED	dropped	absent	absent

Fields

core: MockTimeCore

Current time (coarse)

futures: DenseSlotMap<DefaultKey, Option<Waker>>

Futures; record of every existing SleepFuture, including any Waker

Entry exists iff SleepFuture exists.

Contains None if we haven’t polled the future; Some if we have.

We could use a Vec or TiVec but using a slotmap is more robust against bugs here.

unready: PriorityQueue<DefaultKey, Reverse<Instant>>

Priority queue

Subset of futures.

An entry is present iff the Instant is strictly after State.now, in which case that’s when the future should be woken.

PriorityQueue is a max-heap but we want earliest times, hence Reverse

Implementations

impl State

fn wake_any(&mut self)

Restore the invariant for unready after now has been increased

Ie, ensures that any sleeps which are WAITING/UNPOLLED except that they are <= now, are moved to state READY.

Trait Implementations

impl AsMut<DenseSlotMap<DefaultKey, Option<Waker>>> for State

fn as_mut(&mut self) -> &mut DenseSlotMap<DefaultKey, Option<Waker>>

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<MockTimeCore> for State

fn as_mut(&mut self) -> &mut MockTimeCore

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<PriorityQueue<DefaultKey, Reverse<Instant>>> for State

fn as_mut(&mut self) -> &mut PriorityQueue<DefaultKey, Reverse<Instant>>

Converts this type into a mutable reference of the (usually inferred) input type.

impl Debug for State

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

Formats the value using the given formatter.