Struct queen::timer::wheel::Wheel

pub struct Wheel<E> where
    E: Debug,  { /* fields omitted */ }

An implementation of four-level byte-sized wheel

Implementations

impl<E> Wheel<E> where
    E: Debug, 

pub fn new(pruner: fn(_: &E) -> bool) -> Self

Create a new wheel

pub fn remaining(&self) -> u32

Described how many ticks are left before the timer has wrapped around completely

pub fn current(&self) -> u32

Produces a 32-bit timestamp including the current index of every wheel

pub fn insert(&mut self, e: E, delay: u32) -> Result<(), E>

Insert a new timeout into the wheel to be returned after delay ticks

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

Move the wheel forward by a single unit

Returns a list of all timers that expire during this tick.

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

Skip a certain amount of units

No timers will be executed for the skipped time. Only use this after determining that it’s actually valid with can_skip!

pub fn can_skip(&self) -> Option<u32>

Determine if and how many ticks can be skipped

Trait Implementations

impl<E> Default for Wheel<E> where
    E: Debug, 

fn default() -> Self

Returns the “default value” for a type.