Struct EnqueueOptions 

pub struct EnqueueOptions { /* private fields */ }

Available on crate feature jobs and (crate features model-mysql or model-postgres or model-sqlite) only.

How to enqueue one job (18.35.0): its queue, priority, when to run it, a uniqueness key and its retry count.

use std::time::Duration;
use rust_web_server::jobs::EnqueueOptions;

let options = EnqueueOptions::new()
    .queue("mailers")
    .priority(10)
    .run_in(Duration::from_secs(60))
    .unique("welcome:42")
    .max_retries(5);

Implementations

impl EnqueueOptions

pub fn new() -> Self

pub fn queue(self, name: &str) -> Self

The named queue (default default); workers can be limited to some queues with PersistentJobQueue::queues.

pub fn priority(self, priority: i64) -> Self

Higher runs first among due jobs (default 0; negative is fine).

pub fn run_at(self, at: SystemTime) -> Self

Not before at (second precision).

pub fn run_in(self, delay: Duration) -> Self

Not before delay from now.

pub fn unique(self, key: &str) -> Self

Skip the job when one with the same type and key is already pending or running (enqueue_with then answers that job’s id). Checked when enqueuing: two enqueues in the same instant from different processes can both insert.

pub fn max_retries(self, n: u32) -> Self

Retries after the first attempt (default: the queue’s, 3).

Trait Implementations

impl Clone for EnqueueOptions

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 EnqueueOptions

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

Formats the value using the given formatter.

impl Default for EnqueueOptions

fn default() -> Self

Returns the “default value” for a type.