10 releases

0.4.0 Nov 23, 2022
0.4.0-rc1 May 5, 2021
0.3.5 May 5, 2021
0.3.4 Dec 11, 2020
0.1.0 Sep 7, 2018

#138 in Date and time

Download history 2831/week @ 2024-06-10 2756/week @ 2024-06-17 2650/week @ 2024-06-24 2298/week @ 2024-07-01 2365/week @ 2024-07-08 2661/week @ 2024-07-15 2854/week @ 2024-07-22 3119/week @ 2024-07-29 2417/week @ 2024-08-05 2715/week @ 2024-08-12 2452/week @ 2024-08-19 2701/week @ 2024-08-26 2782/week @ 2024-09-02 2634/week @ 2024-09-09 2714/week @ 2024-09-16 2708/week @ 2024-09-23

11,121 downloads per month
Used in 19 crates (15 directly)

Apache-2.0

77KB
1.5K SLoC

Clokwerk, a simple scheduler

Crate API

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.

Since version 0.4, Clokwerk has also supported a separate AsyncScheduler, which can easily run asynchronous tasks concurrently.

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(Tuesday).at("14:20:17").and_every(Thursday).at("15:00").run(|| println!("Biweekly task"));

// Manually run the scheduler in an event loop
for _ in 1..10 {
    scheduler.run_pending();
    thread::sleep(Duration::from_millis(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();

See documentation for additional examples of usage.

Similar libraries

Dependencies

~1–6MB
~26K SLoC