Struct calloop::timer::TimerHandle

pub struct TimerHandle<T> { /* fields omitted */ }

[−] Expand description

An handle to a timer, used to set or cancel timeouts

This handle can be cloned, and can be sent accross thread as long as T: Send.

Implementations

impl<T> TimerHandle<T>[−]

pub fn add_timeout(&self, delay_from_now: Duration, data: T) -> Timeout[−]

Set a new timeout

The associated data will be given as argument to the callback.

The returned Timeout can be used to cancel it. You can drop it if you don’t plan to cancel this timeout.

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

Cancel a previsouly set timeout and retrieve the associated data

This method returns None if the timeout does not exist (it has already fired or has already been cancelled).

pub fn cancel_all_timeouts(&self)[−]

Cancel all planned timeouts for this timer

All associated data will be dropped.

Trait Implementations

impl<T> Clone for TimerHandle<T>[+]

[+] Show hidden undocumented items

fn clone(&self) -> TimerHandle<T>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.