Enum act_zero::timer::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 of Timeout

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 of Interval

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

pub fn clone(&self) -> TimerState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TimerState

impl Debug for TimerState

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

Formats the value using the given formatter.

impl Default for TimerState

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for TimerState

impl Hash for TimerState

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for TimerState

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TimerState> for TimerState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TimerState> for TimerState

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for TimerState

impl StructuralPartialEq for TimerState