Struct background_jobs_core::JobInfo

pub struct JobInfo {
    pub id: Uuid,
    pub name: String,
    pub queue: String,
    pub args: Value,
    pub retry_count: u32,
    pub max_retries: MaxRetries,
    pub backoff_strategy: Backoff,
    pub next_queue: OffsetDateTime,
    pub heartbeat_interval: u64,
}

Metadata pertaining to a job that exists within the background_jobs system

Although exposed publically, this type should only really be handled by the library itself, and is impossible to create outside of the new_job method.

Fields

id: Uuid

ID of the job

name: String

Name of the job

queue: String

Name of the queue that this job is a part of

args: Value

Arguments for a given job

retry_count: u32

Retries left for this job, None means no limit

max_retries: MaxRetries

the initial MaxRetries value, for comparing to the current retry count

backoff_strategy: Backoff

How often retries should be scheduled

next_queue: OffsetDateTime

The time this job should be dequeued

heartbeat_interval: u64

Milliseconds from execution until the job is considered dead

This is important for storage implementations to reap unfinished jobs

Implementations

impl JobInfo

pub fn unexecuted(self) -> ReturnJobInfo

Convert a JobInfo into a ReturnJobInfo without executing it

pub fn next_queue_id(&self) -> Uuid

Produce a UUID from the next_queue timestamp

pub fn prepare_retry(&mut self) -> bool

Increment the retry-count and set next_queue based on the job’s configuration

returns true if the job should be retried

Trait Implementations

impl Clone for JobInfo

fn clone(&self) -> JobInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JobInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JobInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JobInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JobInfo

impl StructuralPartialEq for JobInfo