Struct timer_queue::TimerQueue

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

Stores values to be yielded at specific times in the future

Time is expressed as a bare u64 representing an absolute point in time. The caller may use any consistent unit, e.g. milliseconds, and any consistent definition of time zero. Larger units limit resolution but make polling over the same real-time interval proportionately faster, whereas smaller units improve resolution, limit total range, and reduce poll performance.

Implementations

impl<T> TimerQueue<T>

pub const fn new() -> Self

Create an empty queue starting at time 0

pub fn with_capacity(n: usize) -> Self

Create a queue for which at least n calls to insert will not require a reallocation

pub fn poll(&mut self, now: u64) -> Option<T>

Returns a timer that has expired by now, if any

now must be at least the largest previously passed value

pub fn next_timeout(&self) -> Option<u64>

Lower bound on when the next timer will expire, if any

pub fn insert(&mut self, timeout: u64, value: T) -> Timer

Register a timer that will yield value at timeout

pub fn reset(&mut self, timer: Timer, timeout: u64)

Adjust timer to expire at timeout

pub fn remove(&mut self, timer: Timer) -> T

Cancel timer

pub fn iter(&self) -> impl ExactSizeIterator<Item = (u64, &T)>

Iterate over all scheduled timers

pub fn get(&self, timer: Timer) -> &T

Borrow the value associated with timer

pub fn get_mut(&mut self, timer: Timer) -> &mut T

Uniquely borrow the value associated with timer

pub fn len(&self) -> usize

Number of scheduled timers

pub fn is_empty(&self) -> bool

Whether no timers are scheduled

Trait Implementations

impl<T: Clone> Clone for TimerQueue<T>

fn clone(&self) -> TimerQueue<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for TimerQueue<T>

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

Formats the value using the given formatter.

impl<T> Default for TimerQueue<T>

fn default() -> Self

Returns the “default value” for a type.