Struct RequestRegistry 

pub struct RequestRegistry { /* private fields */ }

Every request that has not finished.

Implementations

impl RequestRegistry

pub fn new() -> Self

An empty table.

pub fn register( &mut self, id: RequestId, entry: InFlight, ) -> Result<(), DuplicateRequest>

Records a request as in flight.

Errors

DuplicateRequest if the id is already in flight. The existing entry is left alone: the first request owns the id, and displacing it would make a later cancellation abort the wrong work.

pub fn get(&self, id: &RequestId) -> Option<&InFlight>

The entry for id, if it is still in flight.

pub fn get_mut(&mut self, id: &RequestId) -> Option<&mut InFlight>

The entry for id, mutably, if it is still in flight.

pub fn cancel( &mut self, id: &RequestId, reason: Option<CancelReason>, ) -> CancelOutcome

Cancels a request.

Never fails. See CancelOutcome.

pub fn expire(&mut self, now: Instant) -> Vec<RequestId>

Aborts and removes every request whose budget is spent at now.

The returned ids are the ones the caller should report, in no particular order: this runs on a tick rather than per frame, and sorting to make the output deterministic would be work whose result nothing reads.

pub fn complete(&mut self, id: &RequestId) -> Option<InFlight>

Removes a finished request and returns what it was.

pub fn ids(&self) -> impl Iterator<Item = &RequestId>

The ids of every request still in flight.

pub fn len(&self) -> usize

How many requests are in flight.

pub fn is_empty(&self) -> bool

Whether nothing is in flight.

pub fn drain(&mut self) -> Vec<RequestId>

Forgets every request, aborting each so no handler is left waiting.

Used when a session closes. The requests are not going to finish, and a handler awaiting a signal that can never arrive is a leaked task rather than a slow one.

Trait Implementations

impl Debug for RequestRegistry

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

Formats the value using the given formatter.

impl Default for RequestRegistry

fn default() -> Self

Returns the “default value” for a type.