skedge

Rust single-process scheduling. Ported from schedule for Python, in turn inspired by clockwork (Ruby), and "Rethinking Cron" by Adam Wiggins.

Usage

Documentation can be found on docs.rs.

This library uses the Builder pattern to define jobs. Instantiate a fresh Scheduler, then use the every() and every_single() functions to begin defining a job. Finalize configuration by calling Job::run() to add the new job to the scheduler. The Scheduler::run_pending() method is used to fire any jobs that have arrived at their next scheduled run time. Currently, precision can only be specified to the second, no smaller.

use skedge::{every, Scheduler};
use std::{
	thread,
	time::{Duration, SystemTime},
};

fn seconds_from_epoch() -> u64 {
	SystemTime::now()
		.duration_since(SystemTime::UNIX_EPOCH)
		.unwrap()
		.as_secs()
}

fn greet(name: &str) {
	let timestamp = seconds_from_epoch();
	println!("Hello {name}, it's been {timestamp} seconds since the Unix epoch!");
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
	let mut schedule = Scheduler::new();

	every(10)
		.minutes()?
		.at(":17")?
		.until(
			SystemTime::now()
				.checked_add(Duration::from_secs(2 * 60 * 60))
				.unwrap()
				.try_into()?,
		)?
		.run_one_arg(&mut schedule, greet, "Cool Person")?;

	let now = seconds_from_epoch();
	println!("Starting at {now}");
	loop {
		if let Err(e) = schedule.run_pending() {
			eprintln!("Error: {e}");
		}
		thread::sleep(Duration::from_secs(1));
	}
}

Check out the example script to see more configuration options. Try cargo run --example readme or cargo run --example basic to see it in action.

CFFI

There is an experimental C foreign function interface, which is feature-gated and not included by default. To build the library with this feature, use cargo build --features ffi. See the Makefile and examples/ffi/c directory for details on using this library from C. Execute make run to build and execute the included example C program. It currently only supports work functions which take no arguments.

Development

Clone this repo. See CONTRIBUTING.md for contribution guidelines.

Dependencies

Stable Rust. Obtainable via rustup using the instructions at this link.

Crates

jiff - Date and time handling
libc - libc bindings for CFFI (optional)
rand - Random number generation (optional)
regex - Regular expressions
thiserror - Error derive macro
tracing - what it says on the tin

Development-Only

pretty_assertions - Colorful assertion output