Struct Job 

pub struct Job {
    pub id: i32,
    pub payload: String,
    pub status: String,
    pub attempts: i32,
    pub available_at: NaiveDateTime,
    pub created_at: NaiveDateTime,
    pub updated_at: NaiveDateTime,
}

Represents a unit of work in the system. Each Job can be in different states (pending, processing, etc.) and may have multiple attempts if it fails.

Corresponds to the jobs table in the database.

Fields

• id: Primary key of the job record. Auto-generated by the database.
• payload: The data associated with this job (e.g., request parameters, message content).
• status: Current status of the job (e.g., “pending”, “processing”).
• attempts: Number of times an attempt has been made to run this job.
• available_at: A timestamp indicating when this job is eligible to be processed.
• created_at: Timestamp when the job was first created.
• updated_at: Timestamp of the most recent update to the job record.

Fields

id: i32

payload: String

status: String

attempts: i32

available_at: NaiveDateTime

created_at: NaiveDateTime

updated_at: NaiveDateTime

Implementations

impl Job

pub fn new(payload: String) -> Self

Creates a new Job instance without inserting it into the database.

This sets default fields (e.g., status = "pending", attempts = 0, created_at = now, and updated_at = now).

Parameters

• payload: The data associated with the job.

Returns

A new Job struct ready to be inserted into the DB or used in-memory.

pub fn with_time(payload: String, _available_at: NaiveDateTime) -> Self

Creates a new Job with a custom available_at time, without inserting into the database.

Parameters

• payload: The data associated with the job.
• _available_at: The desired time when the job becomes processable.

Returns

A Job struct with default values for other fields.

pub fn create(new_job: NewJob) -> QueryResult<Self>

Inserts a new Job record into the jobs table.

This method will:

• Acquire a database connection from DB::get_conn.
• Run a transaction inserting the provided new_job into the jobs table.
• Fetch and return the newly inserted Job (based on its descending created_at).

Parameters

• new_job: The NewJob struct containing the data to be inserted.

Returns

• Ok(Job) if the insertion succeeded.
• Err(diesel::result::Error) if there was a connection or insertion problem.

Errors

• Returns diesel::result::Error::NotFound if unable to get a DB connection.
• Returns other Diesel errors if insertion or retrieval fails.

pub fn update(self) -> QueryResult<()>

Updates an existing Job record in the jobs table.

The following fields may be updated:

• status (copied from self.status)
• attempts
• available_at
• updated_at (set to now)

Returns

• Ok(()) if the update succeeded.
• Err(diesel::result::Error) if there was a connection or update issue.

pub fn complete(&self, _return_value: String) -> QueryResult<()>

Marks a job as completed by inserting a corresponding ProcessedJob record and then removing the Job from the jobs table.

Parameters

• _return_value: A string containing any relevant result data or message about the job’s completion.

Returns

• Ok(()) if the operation (inserting ProcessedJob and deleting the original Job) succeeded.
• Err(diesel::result::Error) if any database operation failed.

pub fn fail(&mut self, _reason: &str) -> QueryResult<()>

Marks a job as failed. If the job has remaining retry attempts, it increments the job’s attempts and defers its available_at time by the configured retry interval. Otherwise, it inserts a FailedJob record and removes the job from jobs.

Parameters

• _reason: A description of why the job failed.

Returns

• Ok(()) if the job was updated or moved to failed jobs.
• Err(diesel::result::Error) if a database operation fails.

Behavior

• If max_retry_attempts (from Config::get_config) is greater than the current number of attempts, the job is set to retry later.
• Otherwise, a record is inserted into failed_jobs, and the job is deleted from the jobs table.

pub fn fetch_pending_jobs_count() -> QueryResult<i64>

Returns the count of jobs that are currently in pending status and have an available_at time less than or equal to now.

Useful for checking how many pending jobs are ready to be processed.

Returns

• Ok(i64) with the count of matching jobs.
• Err(diesel::result::Error) if there was an issue retrieving data.

pub fn fetch_pending_job() -> QueryResult<Option<Self>>

Fetches the next pending job (the earliest by ID) that is ready to be processed, and marks its status as processing.

Returns

• Ok(Some(Job)) if a pending job was found and updated.
• Ok(None) if no pending job is available.
• Err(diesel::result::Error) if a database operation fails.

Transaction

This operation is performed within a transaction to ensure atomicity: retrieving the job and updating its status happen together.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Job

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'insert> Insertable<table> for &'insert Job

type Values = <(Option<Grouped<Eq<id, <&'insert i32 as AsExpression<<id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<payload, <&'insert String as AsExpression<<payload as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<status, <&'insert String as AsExpression<<status as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<attempts, <&'insert i32 as AsExpression<<attempts as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<available_at, <&'insert NaiveDateTime as AsExpression<<available_at as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<created_at, <&'insert NaiveDateTime as AsExpression<<created_at as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<updated_at, <&'insert NaiveDateTime as AsExpression<<updated_at as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<id, &'insert i32>>, Option<Eq<payload, &'insert String>>, Option<Eq<status, &'insert String>>, Option<Eq<attempts, &'insert i32>>, Option<Eq<available_at, &'insert NaiveDateTime>>, Option<Eq<created_at, &'insert NaiveDateTime>>, Option<Eq<updated_at, &'insert NaiveDateTime>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl Insertable<table> for Job

type Values = <(Option<Grouped<Eq<id, <i32 as AsExpression<<id as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<payload, <String as AsExpression<<payload as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<status, <String as AsExpression<<status as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<attempts, <i32 as AsExpression<<attempts as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<available_at, <NaiveDateTime as AsExpression<<available_at as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<created_at, <NaiveDateTime as AsExpression<<created_at as Expression>::SqlType>>::Expression>>>, Option<Grouped<Eq<updated_at, <NaiveDateTime as AsExpression<<updated_at as Expression>::SqlType>>::Expression>>>) as Insertable<table>>::Values

The VALUES clause to insert these records

fn values( self, ) -> <(Option<Eq<id, i32>>, Option<Eq<payload, String>>, Option<Eq<status, String>>, Option<Eq<attempts, i32>>, Option<Eq<available_at, NaiveDateTime>>, Option<Eq<created_at, NaiveDateTime>>, Option<Eq<updated_at, NaiveDateTime>>) as Insertable<table>>::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl<__DB: Backend, __ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6> Queryable<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6), __DB> for Job

where (i32, String, String, i32, NaiveDateTime, NaiveDateTime, NaiveDateTime): FromStaticSqlRow<(__ST0, __ST1, __ST2, __ST3, __ST4, __ST5, __ST6), __DB>,

type Row = (i32, String, String, i32, NaiveDateTime, NaiveDateTime, NaiveDateTime)

The Rust type you’d like to map from.

fn build( row: (i32, String, String, i32, NaiveDateTime, NaiveDateTime, NaiveDateTime), ) -> Result<Self>

Construct an instance of this type

impl Serialize for Job

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl UndecoratedInsertRecord<table> for Job