Struct QueueConfig 

pub struct QueueConfig {
    pub redis_url: String,
    pub default_queue: String,
    pub prefix: String,
    pub block_timeout: Duration,
    pub max_concurrent_jobs: usize,
    pub delayed_job_poll_interval: Duration,
}

Queue system configuration.

Fields

redis_url: String

Redis connection URL.

default_queue: String

Default queue name.

prefix: String

Prefix for queue keys in Redis.

block_timeout: Duration

How long to block waiting for jobs (in seconds).

max_concurrent_jobs: usize

Maximum number of concurrent jobs per worker.

delayed_job_poll_interval: Duration

How often to check for delayed jobs.

Implementations

impl QueueConfig

pub fn new(redis_url: impl Into<String>) -> QueueConfig

Create a new configuration with a Redis URL.

pub fn from_env() -> QueueConfig

Create configuration from environment variables.

Reads the following environment variables:

• QUEUE_CONNECTION: “sync” or “redis” (defaults to “sync”)
• QUEUE_DEFAULT: Default queue name (defaults to “default”)
• QUEUE_PREFIX: Key prefix in Redis (defaults to “ferro_queue”)
• QUEUE_BLOCK_TIMEOUT: Seconds to block waiting for jobs (defaults to 5)
• QUEUE_MAX_CONCURRENT: Max concurrent jobs per worker (defaults to 10)
• REDIS_URL: Full Redis URL (takes precedence if set)
• REDIS_HOST: Redis host (defaults to “127.0.0.1”)
• REDIS_PORT: Redis port (defaults to 6379)
• REDIS_PASSWORD: Redis password (optional)
• REDIS_DATABASE: Redis database number (defaults to 0)

Example

use ferro_queue::QueueConfig;

// In bootstrap.rs
let config = QueueConfig::from_env();
Queue::init(config).await?;

pub fn is_sync_mode() -> bool

Check if sync queue mode is configured.

When QUEUE_CONNECTION=sync, jobs are processed immediately instead of being pushed to Redis.

pub fn default_queue(self, queue: impl Into<String>) -> QueueConfig

Set the default queue name.

pub fn prefix(self, prefix: impl Into<String>) -> QueueConfig

Set the key prefix.

pub fn block_timeout(self, timeout: Duration) -> QueueConfig

Set the block timeout.

pub fn max_concurrent_jobs(self, count: usize) -> QueueConfig

Set max concurrent jobs.

pub fn queue_key(&self, queue: &str) -> String

Get the Redis key for a queue.

pub fn delayed_key(&self, queue: &str) -> String

Get the Redis key for delayed jobs.

pub fn reserved_key(&self, queue: &str) -> String

Get the Redis key for reserved jobs.

pub fn failed_key(&self) -> String

Get the Redis key for failed jobs.

Trait Implementations

impl Clone for QueueConfig

fn clone(&self) -> QueueConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueueConfig

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

Formats the value using the given formatter.

impl Default for QueueConfig

fn default() -> QueueConfig

Returns the “default value” for a type.