Struct TimeQ

pub struct TimeQ<EntryType: TimerEntryWithDelay> { /* private fields */ }

A TimeQ is a queue datastructure where the contained items are time ordered. The underlying storage is a hashed hierarchical timer wheel, which allows for relatively cheap insertion and popping of ready items. It is also possible to cancel an entry given its id.

Implementations

impl<EntryType: TimerEntryWithDelay> TimeQ<EntryType>

pub fn new() -> Self

pub fn is_empty(&self) -> bool

Returns true if the wheel is empty

pub fn len(&self) -> usize

pub fn insert(&mut self, entry: EntryType) -> Result<(), TimerError<EntryType>>

Insert a new entry

pub fn pop(&mut self) -> PopResult<EntryType>

Returns the set of items that need immediate action

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

Drains the entire contents of the queue, returning all of the contained items