[−][src]Struct tokio_timer::timer::Handle
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. CallingHandle::default().delay(...)
is always equivalent toDelay::new(...)
.
Methods
impl Handle
[src]
pub fn current() -> Handle
[src]
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.
pub fn delay(&self, deadline: Instant) -> Delay
[src]
Create a Delay
driven by this handle's associated Timer
.
pub fn timeout<T>(&self, value: T, deadline: Instant) -> Timeout<T>
[src]
Create a Timeout
driven by this handle's associated Timer
.
pub fn interval(&self, at: Instant, duration: Duration) -> Interval
[src]
Create a new Interval
that starts at at
and yields every duration
interval after that.
Trait Implementations
Auto Trait Implementations
impl Send for Handle
impl Unpin for Handle
impl Sync for Handle
impl !UnwindSafe for Handle
impl !RefUnwindSafe for Handle
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,