relayr 0.4.2

Cron scheduler with a delegated-flavour syntax
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

> We're dsplce.co, check out our work on our website: [dsplce.co](https://dsplce.co) 🖤

# relayr

🏃‍♂️ Effortless delegated cron jobs — scheduled tasks in Rust, made simple.

relayr makes it easy to register cron jobs across your codebase without manual boilerplate. Just annotate functions with a macro, and relayr will auto-discover and schedule them at runtime!

*This crate is a wrapper around [`async-cron-scheduler`](https://crates.io/crates/async-cron-scheduler) to use it in a delegated flavour. If you aren't looking for the delegated way of defining your cron jobs it's probably better for you to use that.*

⸻

## 🖤 Features

✅ Register cron jobs with a simple macro<br>
✅ Fully async<br>
✅ No need to manually wire up each job<br>
✅ Registration happens at compile time thanks to [`inventory`](https://crates.io/crates/inventory)<br>
✅ Validates cron patterns at compile time<br>

⸻

## 📦 Installation

Add to your Cargo.toml:

```toml
relayr = "0.4"
```

This will bring in the core scheduler, inventory, and macro support.

⸻

## 🧪 Example

```rust
use relayr::prelude::*;
use chrono::Local;

#[relayr::cron("1/1 * * * * *")]
async fn print_every_second(_: JobId) -> anyhow::Result<()> {
    println!("🖤 Hello from relayr 0.4.0!");
    Ok(())
}

#[tokio::main]
async fn main() {
  relayr::run::<Local>().await
}
```

## ✅ That’s it!

When `relayr::run() starts`, it automatically picks up all functions decorated with `#[relayr::cron(...)]` and schedules them.

⸻

## 🧠 How it Works
- You annotate functions with `#[relayr::cron("cron pattern")]`.
- Under the hood, the macro registers your function in a global inventory.
- When `relayr::run()` is called:
  - It spins up a scheduler.
  - It iterates over all discovered Cron items.
  - It inserts them into the scheduler automatically.

No manual wiring. No giant match blocks. Just clean, delegated jobs.

⸻

## 📁 Repo & Contributions

📦 **Crate:** [https://crates.io/crates/relayr](https://crates.io/crates/relayr)<br>
🛠️ **Repo:** [https://github.com/dsplce-co/relayr](https://github.com/dsplce-co/relayr)

PRs welcome! Let’s make scheduled Rust ✨clean and effortless.

⸻

## 📄 License

MIT or Apache-2.0, at your option.