Struct Timer 

pub struct Timer { /* private fields */ }

The main structure of this library, a Timer handles scheduling one-off and repeating tasks, which are executed on a background thread. Tasks should be short-lived (as they block the thread) synchronous functions.

Implementations

impl Timer

pub fn new() -> Self

Construct a new Timer. This will immediately start a background thread for executing tasks, which will be shut down on drop.

pub fn with_capacity(cap: usize) -> Self

Construct a new Timer with underlying capacity for the given number of tasks as a microoptimization. This will immediately start a background thread for executing tasks, which will be shut down on drop.

pub fn schedule_in<F: FnOnce() + UnwindSafe + Send + 'static>( &mut self, duration: Duration, f: F, ) -> TaskGuard

Schedule a task to run once, after the given duration

pub fn schedule_at<F: FnOnce() + UnwindSafe + Send + 'static>( &mut self, system_time: SystemTime, f: F, ) -> TaskGuard

Schedule a task to run at a given wall-clock time. This will be converted to an Instant and run according to the monotonic clock, so may have… somewhat unpredictable behavior around leap seconds.

pub fn schedule_repeating<F: FnMut() + UnwindSafe + Send + 'static>( &mut self, interval: Duration, f: F, ) -> TaskGuard

Schedule a task to run periodically, after every interval

pub fn schedule_immediately<F: FnOnce() + UnwindSafe + Send + 'static>( &mut self, f: F, )

Schedule a task to run as soon as possible

Trait Implementations

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Timer

fn drop(&mut self)

Drop the timer and shut down the background thread