Struct QueuedJob 

pub struct QueuedJob {
    pub name: String,
    pub payload: Json,
    pub queue: String,
    pub max_tries: u32,
    pub retry_after: Duration,
    pub delay: Duration,
    pub chain: Option<String>,
    pub then: Vec<QueuedJob>,
}

A job as it is stored: a name, a payload, and the policy for running it.

Everything past the dispatch call deals in this rather than in a concrete type, which is what keeps the Queue trait dyn-compatible.

Fields

name: String

payload: Json

queue: String

max_tries: u32

retry_after: Duration

delay: Duration

How long after being pushed the job becomes visible to a worker.

chain: Option<String>

The chain this job is a step of, when it is one. See crate::Chain.

then: Vec<QueuedJob>

The steps to run after this one succeeds, in order. Empty for a job that stands alone.

Implementations

impl QueuedJob

pub fn new(name: impl Into<String>, payload: Json) -> Self

An envelope built by hand, for a caller that has a name and a payload but no Rust type — a job pushed by another service, say.

pub fn stored_payload(&self) -> Json

The payload as it is stored, with the chain folded in.

A chain rides inside the payload column rather than in columns of its own, so a jobs table created by 0.7 needs no migration to carry one. A job with no chain is stored exactly as before, so every row already in a table reads back unchanged. The keys start with $ so they cannot collide with a payload’s own.

pub fn with_stored_payload(self, stored: Json) -> QueuedJob

The inverse of stored_payload: a job read back from storage, with the chain unfolded and the payload restored.

pub fn to_json(&self) -> Json

The whole envelope as JSON, for a chain’s remaining steps.

pub fn from_json(json: &Json) -> Option<QueuedJob>

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

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

pub fn with_tries(self, tries: u32) -> Self

pub fn with_retry_after(self, retry_after: Duration) -> Self

impl QueuedJob

pub fn next_in_chain(&self) -> Option<QueuedJob>

The job to push once this one has succeeded, if this one is a step in a chain with more to come. The returned job carries the remainder.

Trait Implementations

impl Clone for QueuedJob

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 QueuedJob

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

Formats the value using the given formatter.

impl PartialEq for QueuedJob

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for QueuedJob