QueueConfig

Struct QueueConfig 

Source
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,
}
Expand description

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§

Source§

impl QueueConfig

Source

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

Create a new configuration with a Redis URL.

Source

pub fn from_env() -> Self

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 “cancer_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 cancer_queue::QueueConfig;

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

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.

Source

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

Set the default queue name.

Source

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

Set the key prefix.

Source

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

Set the block timeout.

Source

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

Set max concurrent jobs.

Source

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

Get the Redis key for a queue.

Source

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

Get the Redis key for delayed jobs.

Source

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

Get the Redis key for reserved jobs.

Source

pub fn failed_key(&self) -> String

Get the Redis key for failed jobs.

Trait Implementations§

Source§

impl Clone for QueueConfig

Source§

fn clone(&self) -> QueueConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueueConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QueueConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more