Enum TimerState 

pub enum TimerState {
    Inactive,
    Timeout {
        deadline: Instant,
    },
    Interval {
        deadline: Instant,
        interval: Duration,
    },
}

Timers will be in one of these states.

Variants

Inactive

The timer is inactive. This is the default state.

Timeout

The timer is configured to tick once, when the deadline is reached.

Fields

deadline: Instant

When this timer will tick

Interval

The timer is configured to tick when the deadline is reached, and to repeat at a set interval.

Fields

deadline: Instant

When this timer will next tick

interval: Duration

Interval between ticks.

Implementations

impl TimerState

pub fn deadline(&self) -> Option<Instant>

Returns the point in time when this timer will next fire, or None if the timer is currently inactive.

pub fn interval(&self) -> Option<Duration>

Returns the interval between ticks if the timer is active and set to repeat.

Trait Implementations

impl Clone for TimerState

fn clone(&self) -> TimerState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimerState

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

Formats the value using the given formatter.

impl Default for TimerState

fn default() -> Self

Returns the “default value” for a type.

impl Hash for TimerState

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

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 TimerState

fn cmp(&self, other: &TimerState) -> 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 TimerState

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TimerState

fn partial_cmp(&self, other: &TimerState) -> 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 Copy for TimerState

impl Eq for TimerState

impl StructuralPartialEq for TimerState