Skip to main content

JobContext

Struct JobContext 

Source
pub struct JobContext {
    pub job_id: Uuid,
    pub queue: String,
    pub attempt: u32,
    pub enqueued_at: DateTime<Utc>,
    /* private fields */
}
Expand description

Injected into every job execution. Provides job metadata and shared app state.

§Accessing shared state

State is injected via Queue::with_state and accessed with ctx.state::<T>() — the same mental model as axum’s State<T>:

ⓘ
// Set up — pass your app state once when building the queue
let queue = Queue::new(backend).with_state(Arc::new(db_pool));

// Inside a job — retrieve it by type
impl Perform for MyJob {
    async fn perform(self, ctx: JobContext) -> JobResult {
        let db = ctx.state::<Arc<PgPool>>().expect("db not in state");
        // use db ...
        Ok(())
    }
}

Fields§

§job_id: Uuid

Unique ID of this job instance.

§queue: String

Name of the queue this job was claimed from.

§attempt: u32

Delivery attempt number (1 = first attempt).

§enqueued_at: DateTime<Utc>

When this job was originally enqueued.

Implementations§

Source§

impl JobContext

Source

pub fn state<T: Send + Sync + 'static>(&self) -> Option<&T>

Retrieve shared state by type.

Returns None if no state of type T was set on the queue.

ⓘ
let pool = ctx.state::<Arc<PgPool>>().expect("PgPool not in state");
Source

pub fn is_first_attempt(&self) -> bool

Whether this is the first attempt (attempt == 1).

Source

pub fn is_retry(&self) -> bool

Whether this is a retry (attempt > 1).

Trait Implementations§

Source§

impl Clone for JobContext

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more