Struct os_timer::Timer

pub struct Timer { /* fields omitted */ }

Posix timer wrapper

Implementations

impl Timer

pub const unsafe fn uninit() -> Self

Creates new uninitialized instance.

In order to use it one must call init.

pub fn is_init(&self) -> bool

Returns whether timer is initialized

#[must_use]

pub fn init(&self, cb: Callback) -> bool

Performs timer initialization

cb pointer to function to invoke when timer expires.

Returns whether timer has been initialized successfully or not.

If timer is already initialized does nothing, returning false.

pub fn new(cb: Callback) -> Option<Self>

Creates new timer, invoking provided cb when timer expires.

On failure, returns None

pub fn schedule_interval(&self, timeout: Duration, interval: Duration) -> bool

Schedules timer to alarm periodically with interval with initial alarm of timeout.

Note that if timer has been scheduled before, but hasn’t expire yet, it shall be cancelled. To prevent that user must cancel timer first.

Returns true if successfully set, otherwise on error returns false

pub fn is_scheduled(&self) -> bool

Returns true if timer has been scheduled and still pending.

On Win/Mac it only returns whether timer has been scheduled, as there is no way to check whether timer is ongoing

pub fn cancel(&self)

Cancels ongoing timer, if it was scheduled.

impl Timer

pub const fn schedule(&self) -> Schedule<'_>

Creates new schedule

pub fn schedule_once(&self, timeout: Duration) -> bool

Schedules timer to alarm once after timeout passes.

Note that if timer has been scheduled before, but hasn’t expire yet, it shall be cancelled. To prevent that user must cancel timer first.

Returns true if successfully set, otherwise on error returns false

Trait Implementations

impl Drop for Timer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Timer

impl Sync for Timer