Struct JobContext 

pub struct JobContext {
    pub job_id: Uuid,
    pub job_type: String,
    pub attempt: u32,
    pub max_attempts: u32,
    pub auth: AuthContext,
    /* private fields */
}

Context available to job handlers.

Fields

job_id: Uuid

Job ID.

job_type: String

Job type/name.

attempt: u32

Current attempt number (1-based).

max_attempts: u32

Maximum attempts allowed.

auth: AuthContext

Authentication context (for queries/mutations).

Implementations

impl JobContext

pub fn new( job_id: Uuid, job_type: String, attempt: u32, max_attempts: u32, db_pool: PgPool, http_client: Client, ) -> Self

Create a new job context.

pub fn with_saved(self, data: Value) -> Self

Create a new job context with persisted saved data.

pub fn with_auth(self, auth: AuthContext) -> Self

Set authentication context.

pub fn with_progress(self, tx: Sender<ProgressUpdate>) -> Self

Set progress channel.

pub fn with_env_provider(self, provider: Arc<dyn EnvProvider>) -> Self

Set environment provider.

pub fn db(&self) -> &PgPool

Get database pool.

pub fn http(&self) -> &Client

Get HTTP client.

pub fn progress(&self, percentage: u8, message: impl Into<String>) -> Result<()>

Report job progress.

pub async fn saved(&self) -> Value

Get all saved job data.

Returns data that was saved during job execution via save(). This data persists across retries and is accessible in compensation handlers.

pub async fn set_saved(&self, data: Value) -> Result<()>

Replace all saved job data.

Replaces the entire saved data object. For updating individual keys, use save() instead.

pub async fn save(&self, key: &str, value: Value) -> Result<()>

Save a key-value pair to persistent job data.

Saved data persists across retries and is accessible in compensation handlers. Use this to store information needed for rollback (e.g., transaction IDs, resource handles, progress markers).

Example

ctx.save("charge_id", json!(charge.id)).await?;
ctx.save("refund_amount", json!(amount)).await?;

pub async fn is_cancel_requested(&self) -> Result<bool>

Check if cancellation has been requested for this job.

pub async fn check_cancelled(&self) -> Result<()>

Return an error if cancellation has been requested.

pub async fn heartbeat(&self) -> Result<()>

Send heartbeat to keep job alive (async).

pub fn is_retry(&self) -> bool

Check if this is a retry attempt.

pub fn is_last_attempt(&self) -> bool

Check if this is the last attempt.

Trait Implementations

impl EnvAccess for JobContext

fn env_provider(&self) -> &dyn EnvProvider

Get the environment provider.

fn env(&self, key: &str) -> Option<String>

Get an environment variable.

fn env_or(&self, key: &str, default: &str) -> String

Get an environment variable with a default value.

fn env_require(&self, key: &str) -> Result<String>

Get a required environment variable.

fn env_parse<T: FromStr>(&self, key: &str) -> Result<T>

where T::Err: Display,

Get an environment variable and parse it to the specified type.

fn env_parse_or<T: FromStr>(&self, key: &str, default: T) -> Result<T>

where T::Err: Display,

Get an environment variable and parse it, with a default.

fn env_contains(&self, key: &str) -> bool

Check if an environment variable is set.