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() -> Self

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

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

Example

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

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

pub fn insert<D: Any + Send + Sync>(&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();
assert!(ctx.insert(5i32).is_none());
assert!(ctx.insert(4u8).is_none());
assert_eq!(ctx.insert(9i32), Some(5i32));

Trait Implementations

impl Debug for JobContext

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

Formats the value using the given formatter.

impl Default for JobContext

fn default() -> Self

Returns the “default value” for a type.