Struct tokio_timer::timer::Handle

pub struct Handle { /* fields omitted */ }

Handle to timer instance.

The Handle allows creating Delay instances that are driven by the associated timer.

A Handle is obtained by calling Timer::handle, Handle::current, or Handle::default.

• Timer::handle: returns a handle associated with the specific timer. The handle will always reference the same timer.

• Handle::current: returns a handle to the timer for the execution context at the time the function is called. This function must be called from a runtime that has an associated timer or it will panic. The handle will always reference the same timer.

• Handle::default: returns a handle to the timer for the execution context at the time the handle is used. This function is safe to call at any time. The handle may reference different specific timer instances. Calling Handle::default().delay(...) is always equivalent to Delay::new(...).

Methods

impl Handle

pub fn current() -> Handle

Returns a handle to the current timer.

The current timer is the timer that is currently set as default using with_default.

This function should only be called from within the context of with_default. Calling this function from outside of this context will return a Handle that does not reference a timer. Delay instances created with this handle will error.

See type level documentation for more ways to obtain a Handle value.

Important traits for Delay

impl Future for Delay type Output = ();

pub fn delay(&self, deadline: Instant) -> Delay

Create a Delay driven by this handle's associated Timer.

Important traits for Timeout<T>

impl<T> Future for Timeout<T> where
    T: Future,  type Output = Result<T::Output, Elapsed>;

pub fn timeout<T>(&self, value: T, timeout: Duration) -> Timeout<T>

Create a Timeout driven by this handle's associated Timer.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Handle

fn default() -> Handle

Returns the "default value" for a type.

impl Debug for Handle

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

Formats the value using the given formatter.