Struct WorkerContext 

pub struct WorkerContext {
    pub config: WorkerConfig,
    pub started_at: DateTime<Utc>,
    pub execution_metadata: HashMap<String, String>,
    pub attempt: u32,
    pub previous_exception: Option<String>,
    pub cancel: CancellationToken,
}

Context information provided to workers during job execution

Fields

config: WorkerConfig

Worker configuration

started_at: DateTime<Utc>

When the job execution started

execution_metadata: HashMap<String, String>

Metadata for the current execution

attempt: u32

Attempt number (for retries)

previous_exception: Option<String>

Previous exception if this is a retry

cancel: CancellationToken

Cancellation token for cooperative shutdown. A long-running worker impl can race its work against this token to drop out cleanly when the server is asked to stop:

tokio::select! {
    _ = ctx.cancel.cancelled() => Ok(WorkerResult::retry(
        "shutting down".into(),
        None,
    )),
    res = do_expensive_work() => res,
}

The token is a child of the BackgroundJobServer shutdown token, so calling server.stop() flips every context in flight.

Implementations

impl WorkerContext

pub fn new(config: WorkerConfig) -> Self

Create a new worker context with a detached cancellation token. The server installs a real, shutdown-linked token via WorkerContext::with_cancel.

pub fn retry_from( config: WorkerConfig, attempt: u32, previous_exception: Option<String>, ) -> Self

Create a retry context from a previous attempt

pub fn with_cancel(self, cancel: CancellationToken) -> Self

Override the cancellation token. Builder-style so the server can install the shutdown-linked child token.

pub fn add_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Add execution metadata

pub fn duration(&self) -> Duration

Get execution duration so far

pub fn is_timed_out(&self) -> bool

Check if the job has timed out

pub fn is_retry(&self) -> bool

Check if this is a retry attempt

Trait Implementations

impl Clone for WorkerContext

fn clone(&self) -> WorkerContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerContext

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

Formats the value using the given formatter.