From 4e6657a2e13a9a9a4ba67f35015408403567272f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erik=20Nordstr=C3=B8m?= Date: Sun, 23 Feb 2025 01:35:54 +0100 Subject: [PATCH] Attribute code samples. Mention in README whether there are additional examples of use available in crates repos or not. --- README.md | 42 +++++++++++++++++-- src/apalis_email_service.rs | 2 + src/bin/using-crate-apalis-postgres.rs | 2 + src/bin/using-crate-apalis-sqlite.rs | 4 ++ src/bin/using-crate-clokwerk.rs | 2 + ...te-cron_job.rs => using-crate-cron-job.rs} | 4 +- src/bin/using-crate-cron.rs | 2 + src/bin/using-crate-cron_tab-async.rs | 2 + src/bin/using-crate-cron_tab-sync.rs | 2 + src/bin/using-crate-croner.rs | 26 +++++++----- ...sing-crate-delay_timer-in-async-context.rs | 4 +- src/bin/using-crate-delay_timer-internal.rs | 6 ++- src/bin/using-crate-english-to-cron.rs | 2 + ...crate-tokio-cron-scheduler-postgres_job.rs | 2 + ...g-crate-tokio-cron-scheduler-simple_job.rs | 2 + ...-scheduler-simple_job_tokio_in_a_thread.rs | 2 + src/tcs_helpers.rs | 2 + 17 files changed, 90 insertions(+), 18 deletions(-) rename src/bin/{using-crate-cron_job.rs => using-crate-cron-job.rs} (80%) diff --git a/README.md b/README.md index 76a407b..169ee90 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ Testing different job scheduling and job parsing crates. -## apalis +## Apalis + +In addition to the below, a lot of other `apalis` examples can be found at +. ### PostgreSQL @@ -34,6 +37,10 @@ Run sample program. cargo run --release --bin using-crate-clokwerk ``` +The `clokwerk` repo contains only this single example +in its readme and does *not* contain any other +direct examples of use at the time of writing this. + ## Cron Run sample program. @@ -42,14 +49,22 @@ Run sample program. cargo run --release --bin using-crate-cron ``` -## Cron\_job +The `cron` repo contains only this single example +in its readme and does *not* contain any other +direct examples of use at the time of writing this. + +## Cron-job Run sample program. ```zsh -cargo run --release --bin using-crate-cron_job +cargo run --release --bin using-crate-cron-job ``` +The `cron-job` repo contains a couple of other +direct examples of use in the readme, but nothing +beyond that at the time of writing this. + ## Cron\_tab Run sample programs. @@ -62,6 +77,12 @@ cargo run --release --bin using-crate-cron_tab-sync cargo run --release --bin using-crate-cron_tab-async ``` +The `cron_tab` repo contains only these two examples +in its readme, and a copy of the two same sample programs +at , +and does *not* contain any other direct examples of use +at the time of writing this. + ## Croner Run sample program. @@ -70,6 +91,8 @@ Run sample program. cargo run --release --bin using-crate-croner ``` +Additional examples at . + ## Delay\_timer Run sample programs. @@ -82,6 +105,8 @@ cargo run --release --bin using-crate-delay_timer-internal cargo run --release --bin using-crate-delay_timer-in-async-context ``` +Additional examples at: + ## English-to-cron Run sample program. @@ -90,6 +115,12 @@ Run sample program. cargo run --release --bin using-crate-english-to-cron ``` +The `english-to-cron` repo contains only this example +in its readme, and a copy of the same sample program +at , +and does *not* contain any other direct examples of use +at the time of writing this. + ## Tokio-cron-scheduler Run sample programs. @@ -105,3 +136,8 @@ cargo run --release --bin using-crate-tokio-cron-scheduler-simple_job ```zsh cargo run --release --bin using-crate-tokio-cron-scheduler-postgres_job ``` + +One additional example at +although that one (`nats_job.rs`) is not buildable for me I assume, as enabling the +nats related features did not work for me. Enabling nats features in `Cargo.toml` +for me makes Rust unable to build anything. diff --git a/src/apalis_email_service.rs b/src/apalis_email_service.rs index 252fee6..92af9d5 100644 --- a/src/apalis_email_service.rs +++ b/src/apalis_email_service.rs @@ -1,3 +1,5 @@ +//! Code from + use std::{str::FromStr, sync::Arc}; use apalis::prelude::*; diff --git a/src/bin/using-crate-apalis-postgres.rs b/src/bin/using-crate-apalis-postgres.rs index c597767..c20525e 100644 --- a/src/bin/using-crate-apalis-postgres.rs +++ b/src/bin/using-crate-apalis-postgres.rs @@ -1,3 +1,5 @@ +//! Code from + use anyhow::Result; use apalis::layers::retry::RetryPolicy; use apalis::prelude::*; diff --git a/src/bin/using-crate-apalis-sqlite.rs b/src/bin/using-crate-apalis-sqlite.rs index a9cfe02..ef14e52 100644 --- a/src/bin/using-crate-apalis-sqlite.rs +++ b/src/bin/using-crate-apalis-sqlite.rs @@ -1,3 +1,7 @@ +//! Code from: +//! - +//! - + use anyhow::Result; use apalis::prelude::*; use apalis_sql::sqlite::SqliteStorage; diff --git a/src/bin/using-crate-clokwerk.rs b/src/bin/using-crate-clokwerk.rs index 1edd7b0..6a99025 100644 --- a/src/bin/using-crate-clokwerk.rs +++ b/src/bin/using-crate-clokwerk.rs @@ -1,3 +1,5 @@ +//! Code from + // Scheduler, and trait for .seconds(), .minutes(), etc. use clokwerk::{Job, Scheduler, TimeUnits}; // Import week days and WeekDay diff --git a/src/bin/using-crate-cron_job.rs b/src/bin/using-crate-cron-job.rs similarity index 80% rename from src/bin/using-crate-cron_job.rs rename to src/bin/using-crate-cron-job.rs index 186a78c..9a1cc18 100644 --- a/src/bin/using-crate-cron_job.rs +++ b/src/bin/using-crate-cron-job.rs @@ -1,3 +1,5 @@ +//! Based on code from + use cron_job::{CronJob, Job}; fn main() { @@ -12,7 +14,7 @@ fn main() { // Say hello every second cron.new_job("* * * * * *", hello_job); // Start jobs - cron.start().expect("Failed start jobs."); + cron.start().expect("Failed to start jobs"); } // The function to be executed every second. fn run_every_second() { diff --git a/src/bin/using-crate-cron.rs b/src/bin/using-crate-cron.rs index ba0caa9..f4d70b0 100644 --- a/src/bin/using-crate-cron.rs +++ b/src/bin/using-crate-cron.rs @@ -1,3 +1,5 @@ +//! Code from + use chrono::Utc; use cron::Schedule; use std::str::FromStr; diff --git a/src/bin/using-crate-cron_tab-async.rs b/src/bin/using-crate-cron_tab-async.rs index 8de68d8..03a3d0a 100644 --- a/src/bin/using-crate-cron_tab-async.rs +++ b/src/bin/using-crate-cron_tab-async.rs @@ -1,3 +1,5 @@ +//! Based on code from + use std::sync::Arc; use chrono::{FixedOffset, Local, TimeZone}; diff --git a/src/bin/using-crate-cron_tab-sync.rs b/src/bin/using-crate-cron_tab-sync.rs index c911282..ffc44b0 100644 --- a/src/bin/using-crate-cron_tab-sync.rs +++ b/src/bin/using-crate-cron_tab-sync.rs @@ -1,3 +1,5 @@ +//! Based on code from + use chrono::{FixedOffset, Local, TimeZone}; use cron_tab; diff --git a/src/bin/using-crate-croner.rs b/src/bin/using-crate-croner.rs index 0e5d99e..2b24295 100644 --- a/src/bin/using-crate-croner.rs +++ b/src/bin/using-crate-croner.rs @@ -1,18 +1,22 @@ -use chrono::Utc; +//! Code from + +use chrono::Local; use croner::Cron; fn main() { - // Parse a cron expression to find the next occurrence at 00:00 on Friday - let cron = Cron::new("0 0 * * FRI") + // Parse cron expression for Fridays in December + let cron = Cron::new("0 0 0 31 12 FRI") + // Include seconds in pattern + .with_seconds_optional() + // Ensure both day of month and day of week conditions are met + .with_dom_and_dow() .parse() - .expect("Successful parsing"); + .expect("Couldn't parse cron string"); - // Get the next occurrence from the current time, excluding the current time - let next = cron.find_next_occurrence(&Utc::now(), false).unwrap(); + let time = Local::now(); - println!( - "Pattern \"{}\" will match next at {}", - cron.pattern.to_string(), - next - ); + println!("Finding the next 5 New Year's Eves on a Friday:"); + for time in cron.iter_from(time).take(5) { + println!("{}", time); + } } diff --git a/src/bin/using-crate-delay_timer-in-async-context.rs b/src/bin/using-crate-delay_timer-in-async-context.rs index a4b0b99..17caa25 100644 --- a/src/bin/using-crate-delay_timer-in-async-context.rs +++ b/src/bin/using-crate-delay_timer-in-async-context.rs @@ -1,3 +1,5 @@ +//! Based on code from + use delay_timer::prelude::*; use anyhow::Result; @@ -42,7 +44,7 @@ fn build_task_async_print() -> Result { task_builder .set_task_id(1) - .set_frequency_repeated_by_seconds(6) + .set_frequency_repeated_by_cron_str("@secondly") .set_maximum_parallel_runnable_num(2) .spawn_async_routine(body) } diff --git a/src/bin/using-crate-delay_timer-internal.rs b/src/bin/using-crate-delay_timer-internal.rs index 416463e..8ad7d46 100644 --- a/src/bin/using-crate-delay_timer-internal.rs +++ b/src/bin/using-crate-delay_timer-internal.rs @@ -1,10 +1,12 @@ +//! Code from + use anyhow::Result; use delay_timer::prelude::*; use smol::Timer; use std::time::Duration; fn main() -> Result<()> { - // Build an DelayTimer that uses the default configuration of the `smol` runtime internally. + // Build an DelayTimer that uses the default configuration of the Smol runtime internally. let delay_timer = DelayTimerBuilder::default().build(); // Develop a print job that runs in an asynchronous cycle. @@ -39,7 +41,7 @@ fn build_task_async_print() -> Result { task_builder .set_task_id(1) - .set_frequency_repeated_by_seconds(1) + .set_frequency_repeated_by_cron_str("@secondly") .set_maximum_parallel_runnable_num(2) .spawn_async_routine(body) } diff --git a/src/bin/using-crate-english-to-cron.rs b/src/bin/using-crate-english-to-cron.rs index c053bae..7b2e585 100644 --- a/src/bin/using-crate-english-to-cron.rs +++ b/src/bin/using-crate-english-to-cron.rs @@ -1,3 +1,5 @@ +//! Code from + fn main() { let texts = vec![ "every 15 seconds", diff --git a/src/bin/using-crate-tokio-cron-scheduler-postgres_job.rs b/src/bin/using-crate-tokio-cron-scheduler-postgres_job.rs index 39fc877..56656e1 100644 --- a/src/bin/using-crate-tokio-cron-scheduler-postgres_job.rs +++ b/src/bin/using-crate-tokio-cron-scheduler-postgres_job.rs @@ -1,3 +1,5 @@ +//! Code based on + use jobs::tcs_helpers::{run_example, stop_example}; use tokio_cron_scheduler::{ JobScheduler, PostgresMetadataStore, PostgresNotificationStore, SimpleJobCode, diff --git a/src/bin/using-crate-tokio-cron-scheduler-simple_job.rs b/src/bin/using-crate-tokio-cron-scheduler-simple_job.rs index 1eebf16..b32710e 100644 --- a/src/bin/using-crate-tokio-cron-scheduler-simple_job.rs +++ b/src/bin/using-crate-tokio-cron-scheduler-simple_job.rs @@ -1,3 +1,5 @@ +//! Code based on + use jobs::tcs_helpers::{run_example, stop_example}; use tokio_cron_scheduler::JobScheduler; use tracing::Level; diff --git a/src/bin/using-crate-tokio-cron-scheduler-simple_job_tokio_in_a_thread.rs b/src/bin/using-crate-tokio-cron-scheduler-simple_job_tokio_in_a_thread.rs index 6d82046..bcf71ef 100644 --- a/src/bin/using-crate-tokio-cron-scheduler-simple_job_tokio_in_a_thread.rs +++ b/src/bin/using-crate-tokio-cron-scheduler-simple_job_tokio_in_a_thread.rs @@ -1,3 +1,5 @@ +//! Code based on + use jobs::tcs_helpers::{run_example, stop_example}; use std::error::Error; use tokio_cron_scheduler::JobScheduler; diff --git a/src/tcs_helpers.rs b/src/tcs_helpers.rs index abc58d5..1b71f67 100644 --- a/src/tcs_helpers.rs +++ b/src/tcs_helpers.rs @@ -1,3 +1,5 @@ +//! Code from + use chrono::Utc; use std::time::Duration; use tokio_cron_scheduler::{Job, JobBuilder, JobScheduler, JobSchedulerError};