Struct clokwerk::Job

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

A job to run on the scheduler. Create these by calling Scheduler::every().

Methods

impl<Tz> Job<Tz> where
    Tz: TimeZone, 

pub fn at(&mut self, s: &str) -> &mut Self

Specify the time of day when a task should run, e.g.

let mut scheduler = Scheduler::new();
scheduler.every(1.day()).at("14:32").run(|| println!("Tea time!"));
scheduler.every(Wednesday).at("6:32:21 PM").run(|| println!("Writing examples is hard"));

Times can be specified with or without seconds, and in either 24-hour or 12-hour time. Mutually exclusive with Job::plus().

pub fn plus(&mut self, ival: Interval) -> &mut Self

Add additional precision time to when a task should run, e.g.

let mut scheduler = Scheduler::new();
scheduler.every(1.day())
    .plus(6.hours())
    .plus(13.minutes())
  .run(|| println!("Time to wake up!"));

Mutually exclusive with Job::at().

pub fn and_every(&mut self, ival: Interval) -> &mut Self

Add an additional scheduling to the task. All schedules will be considered when determining when the task should next run.

pub fn run<F>(&mut self, f: F) -> &mut Self where
    F: 'static + FnMut() + Sync + Send, 

Specify a task to run, and schedule its next run

pub fn is_pending(&self) -> bool

Test whether a job is scheduled to run again. This is usually only called by Scheduler::run_pending().

pub fn execute(&mut self)

Run a task and re-schedule it. This is usually only called by Scheduler::run_pending().

Trait Implementations

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

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

Formats the value using the given formatter.