Struct Config 

pub struct Config<DT, ET> {
    pub storage: Storage,
    /* private fields */
}

Fields

storage: Storage

Implementations

impl<DT, ET> Config<DT, ET>

pub fn new(storage: &Storage) -> Self

Creates a new configuration with default settings.

pub fn register_queue<Q>(self) -> Self

where Q: Queue,

Registers a queue by its type.

pub fn register_queue_with(&mut self, config: QueueConfig)

Registers a queue from a QueueConfig.

pub fn register_queue_with_concurrency<Q>(self, concurrency: usize) -> Self

where Q: Queue,

Registers a queue by its type with a custom concurrency limit.

pub fn register_worker<W, A>(self) -> Self

where W: Worker<A, Error = ET> + FromContext<DT> + 'static, A: Job + DeserializeOwned + Send + Sync + 'static, DT: Clone + Send + Sync + 'static, ET: Error + Send + Sync + 'static,

Registers a worker and its associated job type.

pub fn register_worker_with(&mut self, config: WorkerConfig<DT, ET>)

Registers a worker from a WorkerConfig.

pub fn exit_when_processed(self, processed: u64) -> Self

Stops processing after the given number of jobs have been processed. Useful for testing.

pub fn with_graceful_shutdown( self, fut: impl Future<Output = Result<(), Error>> + Send + Sync + 'static, ) -> Self

Sets a future that triggers graceful shutdown when it completes. Defaults to listening for SIGTERM/SIGINT on Unix and Ctrl+C on Windows.

pub fn with_retry_delay_override( self, f: impl Fn(&ET, u32, u64) -> Option<u64> + Send + Sync + 'static, ) -> Self

Sets a global callback to override the retry delay when a job fails.

The callback receives (error, retry_count, default_delay) and returns Some(seconds) to override or None to use the worker’s default.

pub fn consume_shutdown_signal( &mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + Sync + 'static>>

pub fn has_registered_queue<Q: Queue>(&self) -> bool

Returns true if the given queue type has been registered.

pub fn has_registered_worker(&self, name: &str) -> bool

Returns true if a worker with the given name has been registered.

pub fn has_registered_worker_type<W: 'static>(&self) -> bool

Returns true if a worker of the given type has been registered.

pub fn has_registered_cron_worker(&self, name: &str) -> bool

Returns true if a cron worker with the given name has been registered.

pub fn has_registered_cron_worker_type<W: 'static>(&self) -> bool

Returns true if a cron worker of the given type has been registered.

pub fn catalog(&self) -> Catalog

Returns a catalog of all registered workers.