Struct TimerHeap

pub struct TimerHeap<T> { /* private fields */ }

Store timers in a binary heap. Keep them sorted by which timer is going to expire first.

Implementations

impl<T: Eq + Clone + Hash> TimerHeap<T>

pub fn new() -> TimerHeap<T>

Create a new TimerHeap

pub fn len(&self) -> usize

Return the number of timers in the heap

pub fn insert( &mut self, key: T, duration: Duration, ty: TimerType, ) -> Result<(), Error>

Insert a timer into the heap

Return an error if the key already exists.

pub fn upsert(&mut self, key: T, duration: Duration, ty: TimerType) -> bool

Insert a timer into the heap, replacing any existing timer if one exists

Return true if a timer already existed in the heap, false otherwise

pub fn remove(&mut self, key: T) -> bool

Remove a TimerEnry by Id

Return true if it exists, false otherwise

pub fn time_remaining(&self) -> Option<Duration>

Return the amount of time remaining for the earliest expiring timer. Return None if there are no timers in the heap.

pub fn earliest_timeout(&self, user_timeout: Duration) -> Duration

Return the earliest timeout based on a user timeout and the least remaining time in the next timer to fire.

pub fn expired(&mut self) -> Expired<'_, T>

Return all expired keys

Any recurring timers will be re-added to the heap in the correct spot

Trait Implementations

impl<T: Debug + Eq + Clone + Hash + Ord> Debug for TimerHeap<T>

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

Formats the value using the given formatter.