modo-rs 0.8.0

//! # modo::cron
//!
//! Periodic cron job scheduling with plain `async fn` handlers.
//!
//! This module provides a cron scheduler that runs async handler functions on
//! configurable schedules. Handlers are plain async functions — no macros or
//! custom derives required. Services are injected via the
//! [`Registry`](crate::service::Registry) snapshot captured at scheduler build
//! time.
//!
//! Always available — no feature flag required.
//!
//! ## Provides
//!
//! | Export | Description |
//! |--------|-------------|
//! | [`Scheduler`] | Running scheduler handle; implements [`Task`](crate::runtime::Task) for shutdown |
//! | [`SchedulerBuilder`] | Builder returned by [`Scheduler::builder`] |
//! | [`CronOptions`] | Per-job options (timeout); default 300 s |
//! | [`Meta`] | Job metadata injected into handler arguments |
//! | [`CronContext`] | Execution context passed to every handler invocation |
//! | [`CronHandler`] | Trait implemented automatically for matching `async fn` |
//! | [`FromCronContext`] | Trait for types extractable from [`CronContext`] |
//!
//! ## Schedule formats
//!
//! Three formats are accepted wherever a schedule string is required:
//!
//! - **Standard cron expression** — 5-field (`"*/5 * * * *"`) or 6-field with a
//!   leading seconds field (`"0 30 9 * * *"`).
//! - **Named aliases** — `@yearly`, `@annually`, `@monthly`, `@weekly`,
//!   `@daily`, `@midnight`, `@hourly`.
//! - **Interval** — `@every <duration>` where duration is composed of `h`,
//!   `m`, and `s` units, e.g. `@every 5m`, `@every 1h30m`.
//!
//! Invalid expressions or durations return an error at scheduler build time.
//!
//! ## Quick start
//!
//! ```rust,no_run
//! use modo::cron::Scheduler;
//! use modo::service::Registry;
//! use modo::runtime::Task;
//! use modo::Result;
//!
//! async fn cleanup() -> Result<()> {
//!     Ok(())
//! }
//!
//! #[tokio::main]
//! async fn main() {
//!     let registry = Registry::new();
//!
//!     let scheduler = Scheduler::builder(&registry)
//!         .job("@daily", cleanup).unwrap()
//!         .start()
//!         .await;
//!
//!     scheduler.shutdown().await.unwrap();
//! }
//! ```

mod context;
mod handler;
mod meta;
mod schedule;
mod scheduler;

pub use context::CronContext;
pub use context::FromCronContext;
pub use handler::CronHandler;
pub use meta::Meta;
pub use scheduler::{CronOptions, Scheduler, SchedulerBuilder};