Struct Timer

pub struct Timer<'h> { /* private fields */ }

Represents an instance of scheduled timer for a specific task.

Timer instance owns¹ the space for the task’s closure. So when the timer is out of scope, it is forced to stop and destroy the closure during Drop processing.

---

1. However, TimerQueue::fire_onshot does not create Timer instance. That’s why the function need a 'static closure lifetime. ↩

Implementations

impl<'h> Timer<'h>

pub fn change_period(&self, due: Duration, period: Duration) -> Result<()>

Reset the timer with a new due time and a new period.

pub fn close(&mut self) -> Result<()>

Manually close the timer. It is safe to call this method more than once, but it is not thread-safe.

Trait Implementations

impl<'h> Drop for Timer<'h>

fn drop(&mut self)

Executes the destructor for this type.