Struct Timers

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

Available on crate feature net only.

A TimerMap with an async method to wait for the next timer expiration.

Implementations

impl<T> Timers<T>

pub fn new() -> Self

Create a new timer map

pub fn insert(&mut self, instant: Instant, item: T)

Insert a new entry at the specified instant

pub async fn wait_and_drain(&mut self) -> impl Iterator<Item = (Instant, T)>

Wait for the next timer to expire and return an iterator of all expired timers

If the TimerMap is empty, this will return a future that is pending forever. After inserting a new entry, prior futures returned from this method will not become ready. They should be dropped after calling Self::insert, and a new future as returned from this method should be awaited instead.

Trait Implementations

impl<T: Debug> Debug for Timers<T>

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

Formats the value using the given formatter.

impl<T> Default for Timers<T>

fn default() -> Self

Returns the “default value” for a type.