Struct TimingWheel

pub struct TimingWheel<T, R = MillisecondResolution>
where
    R: Resolution,
{ /* private fields */ }

A hierarchical timing wheel with a given entry type and resolution.

Implementations

impl<T, R> TimingWheel<T, R>

where R: Resolution,

pub fn new() -> Self

Create a new timing wheel.

pub fn insert(&mut self, entry: T, delay: Duration) -> Option<T>

Returns the entry if it has already expired.

pub fn tick(&mut self) -> Vec<T>

Advance the timing wheel and collect all entries that have been expired.

pub fn tick_with(&mut self, res: &mut Vec<T>)

Advance the timing wheel and collect all entries that have been expired.

pub fn skip(&mut self, amount: u32)

Skip amount steps, note that this will succeed and no checks will take place.

Use TimingWheel::can_skip to determine if this function can be used without silently dropping any entries that have not been expired.

pub fn can_skip(&self) -> u32

Returns how many steps can be skipped safely without missing entries.

pub fn len(&self) -> usize

Return the amount of entries in the wheel.

pub fn is_empty(&self) -> bool

Return whether the wheel is empty.

pub fn gc(&mut self, threshold: usize)

Due to double buffering the overflow list is never shrunk.

This function can be used to shrink the overflow list if its capacity equals or is over the given threshold.

Trait Implementations

impl<T: Debug, R> Debug for TimingWheel<T, R>

where R: Resolution + Debug,

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

Formats the value using the given formatter.

impl<T, R> Default for TimingWheel<T, R>

where R: Resolution,

fn default() -> Self

Returns the “default value” for a type.