Struct apalis_sql::context::SqlContext

pub struct SqlContext { /* private fields */ }

The context for a job is represented here Used to provide a context when a job is defined through the [Job] trait

Implementations

impl SqlContext

pub fn new(id: TaskId) -> Self

Build a new context with defaults given an ID.

pub fn set_max_attempts(&mut self, max_attempts: i32)

Set the number of attempts

pub fn max_attempts(&self) -> i32

Gets the maximum attempts for a job. Default 25

pub fn id(&self) -> &TaskId

Get the id for a job

pub fn attempts(&self) -> &Attempt

Gets the current attempts for a job. Default 0

pub fn set_attempts(&mut self, attempts: i32)

Set the number of attempts

pub fn done_at(&self) -> &Option<i64>

Get the time a job was done

pub fn set_done_at(&mut self, done_at: Option<i64>)

Set the time a job was done

pub fn run_at(&self) -> &DateTime<Utc>

Get the time a job is supposed to start

pub fn set_run_at(&mut self, run_at: DateTime<Utc>)

Set the time a job should run

pub fn lock_at(&self) -> &Option<i64>

Get the time a job was locked

pub fn set_lock_at(&mut self, lock_at: Option<i64>)

Set the lock_at value

pub fn status(&self) -> &State

Get the job status

pub fn set_status(&mut self, status: State)

Set the job status

pub fn lock_by(&self) -> &Option<WorkerId>

Get the time a job was locked

pub fn set_lock_by(&mut self, lock_by: Option<WorkerId>)

Set lock_by

pub fn last_error(&self) -> &Option<String>

Get the time a job was locked

pub fn set_last_error(&mut self, error: String)

Set the last error

pub fn record_attempt(&mut self)

Record an attempt to execute the request

Trait Implementations

impl Clone for SqlContext

fn clone(&self) -> SqlContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SqlContext

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

Formats the value using the given formatter.