Struct TimerHandle 

pub struct TimerHandle(/* private fields */);

Handle to an I/O dispatcher timer.

Handles represent second-granularity deadlines managed by the current thread’s I/O manager, a timer started with a t seconds timeout expires after at least t and less than t + 1 seconds. The timer clock starts a new second when a timer starts while no other timers are pending, such a timer expires after t seconds. A handle becomes stale after its timer is stopped or replaced and must not be used as an independent cancellation token.

Implementations

impl TimerHandle

pub const ZERO: TimerHandle

A handle that does not refer to an active timer.

pub fn is_set(&self) -> bool

Returns true if this handle refers to a timer deadline.

This does not guarantee that the timer is still registered or has not already elapsed.

pub fn remains(&self) -> Seconds

Returns the whole seconds remaining until this handle’s deadline.

Returns zero if the deadline has elapsed. The remaining time is measured from the cached now(), which lags the clock, and is rounded up.

pub fn instant(&self) -> Instant

Returns the instant represented by this handle.

The instant is based on the current thread’s I/O timer clock. For ZERO, this is the clock’s base instant.

Trait Implementations

impl Add<Seconds> for TimerHandle

type Output = TimerHandle

The resulting type after applying the + operator.

fn add(self, other: Seconds) -> TimerHandle

Performs the + operation.

impl Clone for TimerHandle

fn clone(&self) -> TimerHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TimerHandle

impl Debug for TimerHandle

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

Formats the value using the given formatter.

impl Default for TimerHandle

fn default() -> TimerHandle

Returns the “default value” for a type.

impl Eq for TimerHandle

impl Hash for TimerHandle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TimerHandle

fn cmp(&self, other: &TimerHandle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TimerHandle

fn eq(&self, other: &TimerHandle) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for TimerHandle

fn partial_cmp(&self, other: &TimerHandle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for TimerHandle