Struct CronExpr

Source

pub struct CronExpr {
    pub seconds: Option<CronField>,
    pub minutes: CronField,
    pub hours: CronField,
    pub dom: CronField,
    pub month: CronField,
    pub dow: CronField,
}

Expand description

A parsed cron expression (5-field or 6-field with seconds).

§Example

use tpt_cron_parse::CronExpr;

let expr = CronExpr::parse("0 9 * * 1").unwrap();
assert_eq!(expr.to_human_readable(), "Every Monday at 9:00 AM");

Fields§

§seconds: Option<CronField>

Seconds field — Some for 6-field cron, None for 5-field.

§minutes: CronField

Minutes field.

§hours: CronField

Hours field.

§dom: CronField

Day-of-month field.

§month: CronField

Month field.

§dow: CronField

Day-of-week field.

Implementations§

Source §

impl CronExpr

Source

pub fn parse(s: &str) -> Result<CronExpr, CronError>

Parse a cron expression string (5-field or 6-field).

§Example

use tpt_cron_parse::CronExpr;

let expr = CronExpr::parse("*/5 * * * *").unwrap();
assert_eq!(expr.to_human_readable(), "Every 5 minutes");

Examples found in repository ?

examples/crontab.rs (line 8)

7fn main() {
8    let expr = CronExpr::parse("0 9 * * 1-5").expect("valid cron expression");
9    println!("Parsed as 6-field cron: {}", expr.is_6_field());
10    println!("Human readable: {}", expr.to_human_readable());
11}

Source

pub fn is_6_field(&self) -> bool

Returns true if this is a 6-field cron expression (with seconds).

Examples found in repository ?

examples/crontab.rs (line 9)

7fn main() {
8    let expr = CronExpr::parse("0 9 * * 1-5").expect("valid cron expression");
9    println!("Parsed as 6-field cron: {}", expr.is_6_field());
10    println!("Human readable: {}", expr.to_human_readable());
11}

Source

pub fn to_human_readable(&self) -> String

Convert this cron expression to a human-readable English description.

§Example

use tpt_cron_parse::CronExpr;

assert_eq!(CronExpr::parse("* * * * *").unwrap().to_human_readable(), "Every minute");
assert_eq!(CronExpr::parse("0 * * * *").unwrap().to_human_readable(), "Every hour");
assert_eq!(CronExpr::parse("0 9 * * *").unwrap().to_human_readable(), "Every day at 9:00 AM");
assert_eq!(CronExpr::parse("0 0 1 1 *").unwrap().to_human_readable(), "At 12:00 AM on January 1st");

Examples found in repository ?

examples/crontab.rs (line 10)

7fn main() {
8    let expr = CronExpr::parse("0 9 * * 1-5").expect("valid cron expression");
9    println!("Parsed as 6-field cron: {}", expr.is_6_field());
10    println!("Human readable: {}", expr.to_human_readable());
11}