Struct futures_timer::TimerHandle

pub struct TimerHandle { /* fields omitted */ }

A handle to a Timer which is used to create instances of a Delay.

Methods

impl TimerHandle

pub fn set_as_global_fallback(self) -> Result<(), SetDefaultError>

Configures this timer handle to be the one returned by TimerHandle::default.

By default a global thread is initialized on the first call to TimerHandle::default. This first call can happen transitively through Delay::new. If, however, that hasn't happened yet then the global default timer handle can be configured through this method.

This method can be used to prevent the global helper thread from spawning. If this method is successful then the global helper thread will never get spun up.

On success this timer handle will have installed itself globally to be used as the return value for TimerHandle::default unless otherwise specified.

Errors

If another thread has already called set_as_global_fallback or this thread otherwise loses a race to call this method then it will fail returning an error. Once a call to set_as_global_fallback is successful then no future calls may succeed.

Trait Implementations

impl Clone for TimerHandle

fn clone(&self) -> TimerHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TimerHandle

fn default() -> TimerHandle

Returns the "default value" for a type.

impl Debug for TimerHandle

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

Formats the value using the given formatter.