Skip to main content

TimerHandle

Struct TimerHandle 

Source
pub struct TimerHandle(/* private fields */);
Expand description

Handle to a timer registered with ntex’s local timer wheel.

Dropping the handle cancels the timer. A handle may be reset and reused after it has elapsed.

Timer operations are not reentrant. Registered wakers must not synchronously access the timer wheel when cloned, woken or dropped.

Implementations§

Source§

impl TimerHandle

Source

pub fn new(millis: u64) -> Self

Registers a timer that elapses after millis.

Source

pub fn reset(&self, millis: u64)

Restarts the timer with a new delay in milliseconds.

Source

pub fn elapse(&self)

Completes the timer immediately and wakes its registered task.

Source

pub fn is_elapsed(&self) -> bool

Returns true if this timer has elapsed.

Source

pub fn poll_elapsed(&self, cx: &mut Context<'_>) -> Poll<()>

Polls until this timer has elapsed.

Trait Implementations§

Source§

impl Debug for TimerHandle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for TimerHandle

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.