Struct apalis_core::context::JobContext

pub struct JobContext { /* 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 JobContext

pub fn new(id: JobId) -> Self

Build a new context with defaults given an ID.

pub fn data_opt<D: Any + Send + Sync>(&self) -> Option<&D>

Get an optional reference to a type previously inserted on this JobContext.

Example

let mut ctx = JobContext::new(JobId::new());
assert!(ctx.data_opt::<i32>().is_none());
ctx.insert(5i32);

assert_eq!(ctx.data_opt::<i32>(), Some(&5i32));

pub fn data<D: Any + Send + Sync>(&self) -> Result<&D, JobError>

Get a reference to a type previously inserted on this JobContext.

Errors

If the type requested is not in the JobContext

Example

let mut ctx = JobContext::new(JobId::new());
assert!(ctx.data::<i32>().is_err());
assert_eq!(
    ctx.data::<i32>().unwrap_err().to_string(),
    "MissingContext: Attempted to fetch context of i32. Did you add `.layer(Extension(i32))"
);
ctx.insert(5i32);

assert_eq!(ctx.data::<i32>().unwrap(), &5i32);

pub fn insert<D: Any + Send + Sync + Clone>(&mut self, data: D) -> Option<D>

Insert a type into this JobContext.

Important for embedding data for a job. If a extension of this type already existed, it will be returned.

Example

let mut ctx = JobContext::new(JobId::new());
assert!(ctx.insert(5i32).is_none());
assert!(ctx.insert(4u8).is_none());
assert_eq!(ctx.insert(9i32), Some(5i32));

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) -> &JobId

Get the id for a job

pub fn attempts(&self) -> i32

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<DateTime<Utc>>

Get the time a job was done

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

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<DateTime<Utc>>

Get the time a job was locked

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

Set the lock_at value

pub fn status(&self) -> &JobState

Get the job status

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

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

Trait Implementations

impl Clone for JobContext

fn clone(&self) -> JobContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JobContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JobContext

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

Serialize this value into the given Serde serializer.