Struct calloop::timer::TimerHandle [−][src]
pub struct TimerHandle<T> { /* fields omitted */ }
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
.
Methods
impl<T> TimerHandle<T>
[src]
impl<T> TimerHandle<T>
pub fn add_timeout(
&self,
delay_from_now: Duration,
data: T
) -> Result<Timeout, ()>
[src]
pub fn add_timeout(
&self,
delay_from_now: Duration,
data: T
) -> Result<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.
This method can fail if the timer already has too many pending timeouts, currently
capacity is 2^16
.
pub fn cancel_timeout(&self, timeout: &Timeout) -> Option<T>
[src]
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).
Trait Implementations
impl<T> Clone for TimerHandle<T>
[src]
impl<T> Clone for TimerHandle<T>
fn clone(&self) -> TimerHandle<T>
[src]
fn clone(&self) -> TimerHandle<T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0
[src]Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl<T> Send for TimerHandle<T> where
T: Send,
impl<T> Send for TimerHandle<T> where
T: Send,
impl<T> Sync for TimerHandle<T> where
T: Send,
impl<T> Sync for TimerHandle<T> where
T: Send,