#cron-job #schedule #job-scheduler #job #cron #periodic #jobs

lightspeed_scheduler

An in-process scheduler for periodic jobs. Schedule lets you run Rust functions on a cron-like schedule.

108 releases (51 breaking)

0.58.0 Apr 1, 2024
0.57.0 Feb 1, 2024
0.55.1 Jan 2, 2024
0.55.0 Nov 13, 2023
0.13.6 Jul 2, 2020

#189 in Operating systems

Download history 21/week @ 2024-01-01 4/week @ 2024-01-15 45/week @ 2024-01-29 50/week @ 2024-02-05 70/week @ 2024-02-12 121/week @ 2024-02-19 149/week @ 2024-02-26 96/week @ 2024-03-04 23/week @ 2024-03-11 256/week @ 2024-04-01

281 downloads per month
Used in lightspeed

MIT license

43KB
899 lines

lightspeed-scheduler

An in-process scheduler for periodic jobs. Schedule lets you run Rust functions on a cron-like schedule.

Usage

    use std::time::Duration;
    use lightspeed_scheduler::{job::Job, scheduler::{Scheduler, TryToScheduler}, JobExecutor};
    
    #[tokio::main]
    async fn main() {
        let executor = JobExecutor::new_with_utc_tz();
    
        // Run every 10 seconds with no retries in case of failure
        let retries = None;
        executor
            .add_job_with_scheduler(
                Scheduler::Interval {
                    interval_duration: Duration::from_secs(10),
                    execute_at_startup: true,
                },
                Job::new("hello_job", "job_1", retries, move || {
                    Box::pin(async move {
                        println!("Hello from job. This happens every 10 seconds!");
                        Ok(())
                    })
                }),
            )
            .await;
    

        // Run every day at 2:00 am with two retries in case of failure
        let retries = Some(2);
        executor
        .add_job_with_scheduler(
            "0 0 2 * * *".to_scheduler().unwrap(),
            Job::new("hello_job", "job_2", retries, move || {
                Box::pin(async move {
                    println!("Hello from job. This happens every day at 2 am!");
                    Ok(())
                })
            }),
        )
        .await;

        // Start the job executor
        let _executor_handle = executor.run().await.expect("The job executor should run!");

        // Wait for a signal to stop the job executor
        tokio::signal::ctrl_c().await.unwrap();
        
        // Stop the job executor
        let stop_gracefully = true;
        executor.stop(stop_gracefully).await.expect("The job executor should stop!");
    }

Cron schedule format

Creating a schedule for a job is done using the FromStr impl for the Schedule type of the cron library.

The scheduling format is as follows:

sec   min   hour   day of month   month   day of week   year
*     *     *      *              *       *             *

Time is specified for UTC and not your local timezone. Note that the year may be omitted.

Comma separated values such as 5,8,10 represent more than one time value. So for example, a schedule of 0 2,14,26 * * * * would execute on the 2nd, 14th, and 26th minute of every hour.

Ranges can be specified with a dash. A schedule of 0 0 * 5-10 * * would execute once per hour but only on day 5 through 10 of the month.

Day of the week can be specified as an abbreviation or the full name. A schedule of 0 0 6 * * Sun,Sat would execute at 6am on Sunday and Saturday.

Credits

Originally based on https://github.com/mehcode/schedule-rs

Dependencies

~5–13MB
~107K SLoC