Enum TimerExpMode 

pub enum TimerExpMode<TIMERTYPE: ModeTimeType> {
    None,
    OneShot {
        timeout: TIMERTYPE,
    },
    IntervalDelayed {
        delay_tm: TIMERTYPE,
        interv_tm: TIMERTYPE,
    },
    Interval {
        interv_tm: TIMERTYPE,
    },
}

A timer expiry modes. Not every OS supports every mode. Read comments for the OS specific timer. For the nanoseconds param the max value is 999_999_999 for most OSes.

Variants

None

Disarmed

OneShot

A timer which is triggered once.

Fields

timeout: TIMERTYPE

IntervalDelayed

Interval with the initial delay.

Fields

delay_tm: TIMERTYPE

First event delay.

interv_tm: TIMERTYPE

Interval.

Interval

Interval, with the first timeout event equal to interval values.

Fields

interv_tm: TIMERTYPE

Interval seconds.

Implementations

impl TimerExpMode<AbsoluteTime>

Implementations of the TimerExpMode for AbsoluteTime.

pub fn new_oneshot(abs_time: AbsoluteTime) -> Self

Construct the TimerExpMode::OneShot timer. For the absolute timer only this type is available. The AbsoluteTime should be provided which should be ahead of the OS’es timer.

impl TimerExpMode<RelativeTime>

Implementations of the TimerExpMode for RelativeTime.

pub fn new_oneshot(rel_time: RelativeTime) -> Self

Construct the TimerExpMode::OneShot timer. A RelativeTime should be provided as argument. This type of timer is triggered only once.

pub fn new_interval(rel_time: RelativeTime) -> Self

Constrcut the TimerExpMode::Interval timer. A RelativeTime should be provided as agument which specifies the trigger interval.

pub fn new_interval_with_init_delay( delay_time: RelativeTime, intev_time: RelativeTime, ) -> Self

Construct the TimerExpMode::IntervalDelayed timer. A two RelativeTime arguments should be provided which would set the initial delay and further interval. The initial delay happens only once. Then the interval will be used. If delay_time and intev_time are same, acts as new_interval.

impl<TIMERTYPE: ModeTimeType> TimerExpMode<TIMERTYPE>

pub fn reset() -> Self

Disarms the timer.

Trait Implementations

impl Add<RelativeTime> for TimerExpMode<AbsoluteTime>

type Output = TimerExpMode<AbsoluteTime>

The resulting type after applying the + operator.

fn add(self, rhs: RelativeTime) -> Self::Output

Performs the + operation.

impl AddAssign<RelativeTime> for TimerExpMode<AbsoluteTime>

fn add_assign(&mut self, rhs: RelativeTime)

Performs the += operation.

impl<TIMERTYPE: Clone + ModeTimeType> Clone for TimerExpMode<TIMERTYPE>

fn clone(&self) -> TimerExpMode<TIMERTYPE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TIMERTYPE: Debug + ModeTimeType> Debug for TimerExpMode<TIMERTYPE>

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

Formats the value using the given formatter.

impl<TIMERTYPE: ModeTimeType> Display for TimerExpMode<TIMERTYPE>

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

Formats the value using the given formatter.

impl<TIMERTYPE: ModeTimeType> From<&TimerExpMode<TIMERTYPE>> for itimerspec

Converts from the reference to TimerExpMode of the TIMERTYPE into the itimerspec.

fn from(value: &TimerExpMode<TIMERTYPE>) -> Self

Converts to this type from the input type.

impl From<TimerExpMode<AbsoluteTime>> for PeriodicTaskTime

fn from(value: TimerExpMode<AbsoluteTime>) -> Self

Converts to this type from the input type.

impl From<TimerExpMode<RelativeTime>> for PeriodicTaskTime

fn from(value: TimerExpMode<RelativeTime>) -> Self

Converts to this type from the input type.

impl<TIMERTYPE: ModeTimeType> From<TimerExpMode<TIMERTYPE>> for itimerspec

fn from(value: TimerExpMode<TIMERTYPE>) -> Self

Converts to this type from the input type.

impl<TIMERTYPE: ModeTimeType> From<itimerspec> for TimerExpMode<TIMERTYPE>

Converts from itimerspec into TimerExpMode of the TIMERTYPE.

fn from(value: itimerspec) -> Self

Converts to this type from the input type.

impl<TIMERTYPE: ModeTimeType> Ord for TimerExpMode<TIMERTYPE>

fn cmp(&self, other: &Self) -> 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<TIMERTYPE: PartialEq + ModeTimeType> PartialEq for TimerExpMode<TIMERTYPE>

fn eq(&self, other: &TimerExpMode<TIMERTYPE>) -> 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<TIMERTYPE: ModeTimeType> PartialOrd for TimerExpMode<TIMERTYPE>

fn partial_cmp(&self, other: &Self) -> 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<TIMERTYPE: Copy + ModeTimeType> Copy for TimerExpMode<TIMERTYPE>

impl<TIMERTYPE: Eq + ModeTimeType> Eq for TimerExpMode<TIMERTYPE>

impl<TIMERTYPE: ModeTimeType> StructuralPartialEq for TimerExpMode<TIMERTYPE>