克诺勒

克诺勒是一个功能全面、轻量级且高效的 Rust 库，用于解析和评估 cron 模式。

这是流行的 JavaScript/TypeScript cron 解析器 croner 的 Rust 版本。

功能

• 解析和评估 cron 表达式以计算即将执行的运行时间。
• 遵循 POSIX/Vixie-cron 标准，同时通过添加额外的指定符扩展它，例如 L 用于月份的最后一天和星期几，# 用于月份的第 n 个星期几，W 用于与月份某一天最接近的星期几。
• 评估不同时区的 cron 表达式。
• 支持可选的秒精度 .with_seconds_optional 或 .with_seconds_required
• 支持可选的替代星期几模式，使用 with_alternative_weekdays 以石英风格的星期几代替 POSIX。
• 允许灵活组合 DOM 和 DOW 条件，使模式能够匹配月份特定周的特定星期或特定日期的最接近的星期几。
• 与 chrono 和（可选）chrono-tz 兼容。
• 强大的错误处理。

为什么选择 croner 而不是 cron 或 saffron？

克诺勒结合了 cron 和 saffron 的功能，同时遵循 POSIX/Vixie 的“标准”的相关部分。请参阅此表格

注意 在2023-12-02使用 cron@0.12.0 和 saffron@.0.1.0

入门指南

先决条件

确保您的机器上已安装Rust。如果没有，您可以从官方Rust网站获取。

安装

将 croner 添加到您的 Cargo.toml 依赖项中

[dependencies]
croner = "2.0.5" # Adjust the version as necessary

用法

以下是一个快速示例，帮助您开始匹配当前时间，并找到下一个发生的时间。 is_time_matching 接收一个 chrono DateTime

use croner::Cron;
use chrono::Local;

fn main() {

    // Parse cron expression
    let cron_all = Cron::new("18 * * * 5")
      .parse()
      .expect("Couldn't parse cron string");

    // Compare cron pattern with current local time
    let time = Local::now();
    let matches_all = cron_all.is_time_matching(&time).unwrap();

    // Get next match
    let next = cron_all.find_next_occurrence(&time, false).unwrap();

    // Output results
    println!("Time is: {}", time);
    println!("Pattern \"{}\" does {} time {}", cron_all.pattern.to_string(), if matches_all { "match" } else { "not match" }, time );
    println!("Pattern \"{}\" will match next time at {}", cron_all.pattern.to_string(), next);

}

要匹配非本地时区，croner支持带有时区的chrono DateTime的 DateTime<Tz>。要使用命名时区，您可以使用 chrono-tz crate。

use croner::Cron;
use chrono::Local;
use chrono_tz::Tz;

fn main() {
    // Parse cron expression
    let cron = Cron::new("18 * * * 5")
      .parse()
      .expect("Couldn't parse cron string");

    // Choose a different time zone, for example America/New_York
    let est_timezone: Tz = "America/New_York".parse().expect("Invalid timezone");

    // Find the next occurrence in EST
    let time_est = Local::now().with_timezone(&est_timezone);
    let next_est = cron.find_next_occurrence(&time_est, false).unwrap();

    // Output results for EST
    println!("EST time is: {}", time_est);
    println!(
        "Pattern \"{}\" will match next time at (EST): {}",
        cron.pattern.to_string(),
        next_est
    );
}

此示例演示了如何计算下一个5个在星期五的除夕。我们将使用cron表达式匹配12月（12）的每个星期五（FRI），并使用 with_dom_and_dow 方法确保月份和星期几的条件都满足。

use croner::Cron;
use chrono::Local;

fn main() {
    // 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("Couldn't parse cron string");

    let time = Local::now();

    println!("Finding the next 5 New Year's Eves on a Friday:");
    for time in cron.iter_from(time).take(5) {
        println!("{}", time);
    }
}

模式

Croner使用的表达式与Vixie Cron非常相似，但增加了一些修改，如下所述

// ┌──────────────── (optional) second (0 - 59)
// │ ┌────────────── minute (0 - 59)
// │ │ ┌──────────── hour (0 - 23)
// │ │ │ ┌────────── day of month (1 - 31)
// │ │ │ │ ┌──────── month (1 - 12, JAN-DEC)
// │ │ │ │ │ ┌────── day of week (0 - 6, SUN-Mon)
// │ │ │ │ │ │       (0 to 6 are Sunday to Saturday; 7 is Sunday, the same as 0)
// │ │ │ │ │ │
// * * * * * *

• Croner表达式有以下附加修饰符
  • ?：在croner的Rust版本中，问号的行为与*相同，以便可以使用旧版cron模式。
  • L：字母'L'可以用于月份中的天数字段，表示月的最后一天。当与#字符一起使用在星期几字段中时，表示该月的最后特定星期几。例如，5#L 表示该月的最后一个星期五。
  • #：#字符指定一个月中特定天次的“第N个”出现。例如，在星期几字段中提供 5#2 表示该月的第二个星期五。这可以与范围和天名结合使用。例如，MON-FRI#2 将匹配该月的第二周的星期一至星期五。
  • W：字符'W'用于在月份中的天数字段中指定与给定日期最接近的星期几。例如，15W将匹配该月最接近15号的星期几。如果指定的日期落在周末（星期六或星期日），则模式将匹配该日期之前或之后的最近工作日。例如，如果15号是星期六，15W将匹配14号（星期五），如果15号是星期日，它将匹配16号（星期一）。

let cron = Cron::new("*/10 * * * * *") // Every 10 seconds
    .with_seconds_optional()
    .parse()
    .expect("Invalid cron pattern");

let cron = Cron::new("5 */2 * * * *") // At 5 seconds past every 2 minutes
    .with_seconds_required()
    .parse()
    .expect("Invalid cron pattern");

let cron = Cron::new("0 0 25 * FRI") // When christmas day is on a friday
    .with_dom_and_dow()
    .parse()
    .expect("Invalid cron pattern");

let cron = Cron::new("0 0 12 * * 6") // Every Friday (denoted with 6 in Quartz mode) at noon
    .with_alternative_weekdays()
    .parse()
    .expect("Invalid cron pattern");