Struct Config 

pub struct Config {
    pub batch_size: usize,
    pub heartbeat_interval: Duration,
    pub missed_heartbeats: usize,
    pub queue: Queue,
    pub database_url: Option<String>,
    pub lock_tasks: bool,
    pub persist_results: bool,
}

Configuration for a worker’s queue, batching, and liveness detection.

Config controls how jobs are fetched from a queue and how worker liveness is monitored.

Defaults

• batch_size: 10
• heartbeat_interval: 30 seconds
• missed_heartbeats: 2
• queue: "default"
• database_url: None
• lock_tasks: true
• persist_results: true

Fields

batch_size: usize

The maximum number of jobs fetched in a single batch.

Must be greater than zero.

heartbeat_interval: Duration

The interval between worker heartbeats.

missed_heartbeats: usize

The number of missed heartbeats allowed before a worker is considered dead.

queue: Queue

The queue from which jobs are consumed.

database_url: Option<String>

An optional database URL used by the worker.

lock_tasks: bool

Whether tasks should be locked while being processed.

persist_results: bool

Whether job results should be persisted.

Implementations

impl Config

pub fn batch_size(self, size: usize) -> Self

Sets the maximum number of jobs to fetch in a single batch.

Larger batches can improve throughput by reducing the number of queue operations, while smaller batches can reduce memory usage and improve job distribution between workers.

Panics

Panics if size is 0.

Examples

use apalis_sqlite::Config;

let config = Config::default().batch_size(50);

assert_eq!(config.batch_size, 50);

pub fn heartbeat_interval(self, interval: Duration) -> Self

Sets the interval between worker heartbeats.

A shorter interval detects failed workers sooner but produces heartbeat activity more frequently.

Examples

use std::time::Duration;
use apalis_sqlite::Config;

let config = Config::default()
    .heartbeat_interval(Duration::from_secs(15));

assert_eq!(config.heartbeat_interval, Duration::from_secs(15));

pub fn queue(self, queue: impl AsRef<str>) -> Self

Sets the queue from which jobs are consumed.

Examples

let config = Config::default()
    .queue("high-priority");

assert_eq!(config.queue.as_ref(), "high-priority");

pub fn missed_heartbeats(self, missed_heartbeats: usize) -> Self

Sets the number of missed heartbeats allowed before a worker is considered dead.

This value works together with Self::heartbeat_interval. For example, a 30-second heartbeat interval with 2 missed heartbeats results in an orphan timeout of 60 seconds.

Examples

use apalis_sqlite::Config;

let config = Config::default().missed_heartbeats(3);

assert_eq!(config.missed_heartbeats, 3);
assert_eq!(
    config.orphaned_duration(),
    std::time::Duration::from_secs(90)
);

pub fn database_url(self, database_url: impl Into<String>) -> Self

Sets the database URL used by the worker.

Examples

use apalis_sqlite::Config;

let config = Config::default()
    .database_url(":memory:");

assert_eq!(
    config.database_url.as_deref(),
    Some(":memory:")
);

pub fn lock_tasks(self, lock_tasks: bool) -> Self

Enables or disables task locking.

When enabled, tasks are locked while being processed to prevent multiple workers from processing the same task concurrently.

Examples

use apalis_sqlite::Config;

let config = Config::default().lock_tasks(false);

assert!(!config.lock_tasks);

pub fn persist_results(self, persist_results: bool) -> Self

Enables or disables result persistence.

When enabled, results produced by completed jobs are persisted.

Examples

use apalis_sqlite::Config;

let config = Config::default().persist_results(false);

assert!(!config.persist_results);

pub fn orphaned_duration(&self) -> Duration

Returns the amount of time after which a worker may be considered orphaned.

The duration is calculated as:

heartbeat_interval × missed_heartbeats

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config