Struct Timer 

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

A timer.

Typical usage goes like this:

• register the timer with a mio::Poll.
• set a timeout, by calling Timer::set_timeout. Here you provide some state to be associated with this timeout.
• poll the Poll, to learn when a timeout has occurred.
• retrieve state associated with the timeout by calling Timer::poll.

You can omit use of the Poll altogether, if you like, and just poll the Timer directly.

Implementations

impl<T> Timer<T>

pub fn set_timeout(&mut self, delay_from_now: Duration, state: T) -> Timeout

Set a timeout.

When the timeout occurs, the given state becomes available via poll.

pub fn set_timeout_from( &mut self, now: Instant, delay_from_now: Duration, state: T, ) -> Timeout

Self::set_timeout, counting delay_from_now from the caller’s now instead of re-reading the clock.

A caller that already holds the instant its deadline was computed against uses this so the entry lands on the grid point that deadline maps to, however long ago now was read — and a test can place an entry at an exact instant.

pub fn reset_timeout( &mut self, timeout: &Timeout, delay_from_now: Duration, ) -> Option<Timeout>

Resets a timeout.

pub fn cancel_timeout(&mut self, timeout: &Timeout) -> Option<T>

Cancel a timeout.

If the timeout has not yet occurred, the return value holds the associated state.

pub fn poll(&mut self) -> Option<T>

Poll for an expired timer.

The return value holds the state associated with the first expired timer, if any.

pub fn poll_at(&mut self, now: Instant) -> Option<T>

Self::poll as of now rather than the current instant, so a test can drive the wheel from a simulated clock.

pub fn next_poll_date(&self) -> Option<Instant>

Trait Implementations

impl<T> Default for Timer<T>

fn default() -> Timer<T>

Returns the “default value” for a type.