1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! # Clokwerk, a simple scheduler
//!
//! Clokwerk is a simple scheduler, inspired by Python's [Schedule](https://schedule.readthedocs.io/en/stable/)
//! and Ruby's [clockwork](https://github.com/Rykian/clockwork). It uses a similar DSL for scheduling, rather than
//! parsing cron strings.
//!
//! ## Usage
//! ```rust
//! // 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(Tuesday).at("14:20:17").and_every(Thursday).at("15:00").run(|| println!("Biweekly 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_millis(10));
//!     # break;
//! }
//!
//! // 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
//! * [schedule-rs](https://github.com/mehcode/schedule-rs) and [job_scheduler](https://github.com/lholden/job_scheduler) are two other Rust scheduler libraries. Both use `cron` syntax for scheduling.
extern crate chrono;

mod intervals;
mod job;
mod scheduler;

use intervals::RunConfig;
pub use intervals::{Interval, TimeUnits};
pub use job::Job;
pub use scheduler::{ScheduleHandle, Scheduler};