asonix/background-jobs
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Document available features

Browse source
This commit is contained in:
asonix 2024-01-18 13:10:30 -05:00
parent 9141f662d7
commit a0c924a4f3
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/lib.rs
View file

@ -160,6 +160,18 @@
//! If you want to create your own jobs processor based on this idea, you can depend on the
//! `background-jobs-core` crate, which provides the Job trait, as well as some
//! other useful types for implementing a jobs processor and job store.
//!
//! ### Available Features
//!
//! | feature | description |
//! | -------------------- | --------------------------------------------------------------------------------------------------- |
//! | `actix-rt` | Enables the actix-based job runner and the ActixTimer for the in-memory job storage implementation |
//! | `metrics` | Enables the metrics subscriber to extract metrics from the MetricsStorage adapter |
//! | `postgres` | Enables the postgres job storage adapter |
//! | `sled` | Enables the sled job storage adapter |
//! | `tokio` | Enables the tokio-based job runner and the TokioTimer for the in-memory job storage impelementation |
//! | `completion-logging` | Enables a tracing event that occurs whenever a job completes |
//! | `error-logging` | Enables a tracing event that occurs whenever a job fails |
pub use background_jobs_core::{Backoff, Job, MaxRetries, UnsendJob, UnsendSpawner};