Struct clokwerk::Scheduler

pub struct Scheduler<Tz = Local> where
    Tz: TimeZone,  { /* fields omitted */ }

Job scheduler

Methods

impl Scheduler

pub fn new() -> Self

Create a new scheduler. Dates and times will be interpretted using the local timezone

pub fn with_tz<Tz: TimeZone>(tz: Tz) -> Scheduler<Tz>

Create a new scheduler. Dates and times will be interpretted using the specified

impl<Tz> Scheduler<Tz> where
    Tz: TimeZone + Sync + Send, 

pub fn every(&mut self, ival: Interval) -> &mut Job<Tz>

Add a new job to the scheduler to be run on the given interval

let mut scheduler = Scheduler::new();
scheduler.every(10.minutes()).plus(30.seconds()).run(|| println!("Periodic task"));
scheduler.every(1.day()).at("3:20 pm").run(|| println!("Daily task"));
scheduler.every(Wednesday).at("14:20:17").run(|| println!("Weekly task"));
scheduler.every(Weekday).run(|| println!("Every weekday at midnight"));

pub fn run_pending(&mut self)

Run all jobs that should run at this time.

use std::thread;
use std::time::Duration;
loop {
    scheduler.run_pending();
    thread::sleep(Duration::from_millis(100));
}

impl<Tz> Scheduler<Tz> where
    Tz: TimeZone + Sync + Send + 'static,
    <Tz as TimeZone>::Offset: Send, 

pub fn watch_thread(self, frequency: Duration) -> ScheduleHandle

Start a background thread to call Scheduler::run_pending() with the specified frequency. The resulting thread fill end cleanly if the returned ScheduleHandle is dropped.

Trait Implementations

impl Default for Scheduler

fn default() -> Self

Returns the "default value" for a type.

impl<Tz: Debug> Debug for Scheduler<Tz> where
    Tz: TimeZone, 

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

Formats the value using the given formatter.