Struct calloop::timer::TimerHandle
source · pub struct TimerHandle<T> { /* private fields */ }
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
sourceimpl<T> TimerHandle<T>
impl<T> TimerHandle<T>
sourcepub fn add_timeout(&self, delay_from_now: Duration, data: T) -> Timeout
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.
This method can fail if the timer already has too many pending timeouts, currently
capacity is 2^16
.
sourcepub fn cancel_timeout(&self, timeout: &Timeout) -> Option<T>
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
sourceimpl<T> Clone for TimerHandle<T>
impl<T> Clone for TimerHandle<T>
sourcefn clone(&self) -> TimerHandle<T>
fn clone(&self) -> TimerHandle<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations
impl<T> RefUnwindSafe for TimerHandle<T>
impl<T> Send for TimerHandle<T>where
T: Send,
impl<T> Sync for TimerHandle<T>where
T: Send,
impl<T> Unpin for TimerHandle<T>
impl<T> UnwindSafe for TimerHandle<T>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more