Struct riddle_time::TimerHandle

pub struct TimerHandle { /* fields omitted */ }

A handle to a timer created by crate::TimeSystem::register_timer.

It can be used to detect whether the timer has triggered, and to cancel the timer if it hasn't been triggered yet.

Implementations

impl TimerHandle

pub fn cancel(&self)

Cancel a pending timer.

If the timer has already fired, or been cancelled, this is a no-op.

Example

let timer_handle = time_system.register_timer(Duration::from_millis(200),
    move || { panic!("The timer should never fire"); }
);

timer_handle.cancel();

// The panic! never fires because the timer was cancelled.

pub fn pending(&self) -> bool

Check whether a timer has yet to fire.

If the timer was cancelled before it was fired, this will remain true.

Example

let timer_handle = time_system.register_timer(Duration::from_millis(200), || {});

assert_eq!(true, timer_handle.pending());

// A while later
// The timer has fired and is no longer pending
assert_eq!(false, timer_handle.pending());