Struct QueuedJob 

pub struct QueuedJob {
    pub id: String,
    pub name: String,
    pub payload: Value,
    pub queue: String,
    pub attempts: u32,
    pub max_attempts: u32,
    pub available_at: DateTime<Utc>,
    pub created_at: DateTime<Utc>,
    pub unique_key: Option<String>,
}

A job serialised for the queue.

Fields

id: String

A unique id for this queued instance.

name: String

The Job::NAME the registry resolves.

payload: Value

The job’s serialised body.

queue: String

Which queue it is on.

attempts: u32

How many times it has been attempted.

max_attempts: u32

How many attempts it gets.

available_at: DateTime<Utc>

The earliest it may run — how delays are expressed.

created_at: DateTime<Utc>

When it was enqueued.

unique_key: Option<String>

The uniqueness lock this job holds, if it declared a unique_id.

Carried on the job rather than kept by the dispatcher, because the process that releases it is a worker, in another process, minutes later. None for the ordinary case.

Implementations

impl QueuedJob

pub fn from_job<J: Job>(job: &J) -> Result<Self>

Serialise job for the queue.

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

Put it on a different queue.

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

Hold it back for delay.

pub fn available_at(self, at: DateTime<Utc>) -> Self

Make it available no earlier than at.

pub fn is_available(&self) -> bool

Whether it may run now.

pub fn is_exhausted(&self) -> bool

Whether every attempt has been used.

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<'de> Deserialize<'de> for QueuedJob

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QueuedJob

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QueuedJob

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QueuedJob