Skip to main content

TimerState

Struct TimerState 

Source
pub struct TimerState { /* private fields */ }
Expand description

Internal timer state

Stored in the node’s timer collection.

Implementations§

Source§

impl TimerState

Source

pub fn new_with_fn( period: TimerDuration, mode: TimerMode, callback: TimerCallbackFn, ) -> Self

Create a new timer state with function pointer callback

Source

pub fn new_inert(period: TimerDuration) -> Self

Create an inert timer state

Source

pub fn period(&self) -> TimerDuration

Get the timer period

Source

pub fn mode(&self) -> TimerMode

Get the timer mode

Source

pub fn is_canceled(&self) -> bool

Check if the timer is canceled

Source

pub fn cancel(&mut self)

Cancel the timer

Source

pub fn reset(&mut self)

Reset the timer (uncancels and resets elapsed time)

Source

pub fn is_ready(&self) -> bool

Check if the timer is ready to fire

Source

pub fn time_until_next_call(&self) -> TimerDuration

Get time until next call (0 if ready)

Source

pub fn time_since_last_call(&self) -> TimerDuration

Get time since last call

Source

pub fn set_callback_fn(&mut self, callback: TimerCallbackFn)

Set callback to function pointer

Source

pub fn set_repeating(&mut self)

Set timer to repeating mode

Source

pub fn set_oneshot(&mut self)

Set timer to one-shot mode

Source

pub fn set_inert(&mut self)

Set timer to inert mode

Trait Implementations§

Source§

impl Debug for TimerState

Source§

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

Formats the value using the given formatter. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.