Struct WorkerOptions 

pub struct WorkerOptions {
    pub queues: Vec<String>,
    pub sleep: Duration,
    pub max_jobs: Option<u64>,
    pub stop_when_empty: bool,
    pub timeout: Option<Duration>,
}

How a worker behaves.

Fields

queues: Vec<String>

The queues to serve, in priority order — earlier ones are drained first, which is how a high queue gets ahead of default.

sleep: Duration

How long to wait before looking again when every queue is empty.

max_jobs: Option<u64>

Stop after this many jobs. None runs forever.

stop_when_empty: bool

Stop as soon as the queues are empty, rather than waiting for more.

timeout: Option<Duration>

Give up on a job that runs longer than this.

Implementations

impl WorkerOptions

pub fn queues(self, queues: impl IntoIterator<Item = impl Into<String>>) -> Self

Serve these queues, in priority order.

pub fn sleep(self, sleep: Duration) -> Self

Wait this long between polls of an empty queue.

pub fn max_jobs(self, max: u64) -> Self

Stop after max jobs — for a worker that should recycle periodically.

pub fn stop_when_empty(self) -> Self

Return as soon as there is nothing left to do.

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

Abandon a job that exceeds this duration.

Trait Implementations

impl Clone for WorkerOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerOptions

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

Formats the value using the given formatter.

impl Default for WorkerOptions

fn default() -> Self

Returns the “default value” for a type.