Expand description
later
A background job manager and runner for Rust.
How to enqueue Fire and Forget jobs
1. Import later and required dependencies
later = { version = "0.0.1" }
serde = "1.0"
2. Define some types to use as a payload to the background jobs
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize)] // <- Required derives
pub struct SendEmail {
pub address: String,
pub body: String,
}
// ... more as required
3. Generate the stub
later::background_job! {
struct Jobs {
// Use the format
// name: Payload type (defined above)
send_email: SendEmail,
// ..
}
}4. Use the generated code to bootstrap the background job server
For struct Jobs a type JobsBuilder will be generated. Use this to bootstrap the server.
// bootstrap the server
let job_ctx = JobContext {};
let ctx = MyContext{ /*..*/ }; // Any context to pass onto the handles
let bg_jobs = DeriveHandlerBuilder::new(
ctx, // Pass the context here
"fnf-example".into(), // Unique name for this app
"amqp://guest:guest@localhost:5672".into(), // RabbitMq instance
)
// for each payload defined in the `struct Jobs` above
// the generated fn name uses the pattern "with_[name]_handler"
.with_send_email_handler(handle_send_email) // Pass the handler function
// ..
.build()
.expect("start BG Jobs server");
// use bg_jobs.enqueue(SendEmail{ ... }) to enqueue jobs,
// this will only accept types defined inside the macro above
// define handler
fn handle_send_email(
ctx: &JobContext<MyContext>, // JobContext is generated wrapper
payload: SendEmail,
) -> anyhow::Result<()> {
// handle `payload`
// ctx.app -> Access the MyContext passed during bootstrapping
// ctx.enqueue(_) or ctx.jobs.enqueue(_) to enqueue more jobs
Ok(()) // or Err(_) to retry this message
}Project status
This is PoC at this moment. I aim to make something like Hangfire for .NET. Upcoming features are
- Multiple storage backend (redis, postgres)
- Continuation
- Delayed Jobs
- Recurring jobs
- Dashboard
- Use storage backend for scheduling (to remove dependency to RabbitMQ)
Re-exports
pub use anyhow;pub use serde_json;