#scheduler #job

clokwerk

A simple Rust recurring task scheduler, similar to Python’s schedule

3 unstable releases

0.2.1 Jul 5, 2019
0.2.0 Jul 3, 2019
0.1.0 Sep 7, 2018

#17 in Date and time

Download history 1041/week @ 2019-03-22 814/week @ 2019-03-29 548/week @ 2019-04-05 236/week @ 2019-04-12 168/week @ 2019-04-19 278/week @ 2019-04-26 140/week @ 2019-05-03 91/week @ 2019-05-10 442/week @ 2019-05-17 608/week @ 2019-05-24 1086/week @ 2019-05-31 684/week @ 2019-06-07 592/week @ 2019-06-14 653/week @ 2019-06-21 716/week @ 2019-06-28

2,103 downloads per month
Used in 1 crate

Apache-2.0

35KB
607 lines

Clokwerk, a simple scheduler

Clokwerk is a simple scheduler, inspired by Python's Schedule and Ruby's clockwork. It uses a similar DSL for scheduling, rather than parsing cron strings.

By default, times and dates are relative to the local timezone, but the scheduler can be made to use a different timezone using the Scheduler::with_tz constructor.

Usage

// Scheduler, and trait for .seconds(), .minutes(), etc.
use clokwerk::{Scheduler, TimeUnits};
// Import week days and WeekDay
use clokwerk::Interval::*;
use std::thread;
use std::time::Duration;

// Create a new scheduler
let mut scheduler = Scheduler::new();
// or a scheduler with a given timezone
let mut scheduler = Scheduler::with_tz(chrono::Utc);
// Add some tasks to it
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"));

// Manually run the scheduler in an event loop
for _ in 1..10 {
    scheduler.run_pending();
    thread::sleep(Duration::from_secs(10));
}

// Or run it in a background thread
let thread_handle = scheduler.watch_thread(Duration::from_millis(100));
// The scheduler stops when `thread_handle` is dropped, or `stop` is called
thread_handle.stop();

Caveats

Some combinations of times or intervals are permissible, but make little sense, e.g. every(10.seconds()).at("16:00"), which would next run at the next 4 PM after the next multiple of 10 seconds.

Similar libraries

Dependencies

~1MB
~15K SLoC