Struct JobContext 

pub struct JobContext {
    pub id: String,
    pub chain: Option<String>,
    /* private fields */
}

What a running job is handed: who it is, and where to say how far it has got.

Fields

id: String

The driver’s id for this job.

chain: Option<String>

The chain this job is a step of, when it is one. Progress reported here is recorded under the chain as well, so a UI following a pipeline has one key to watch.

Implementations

impl JobContext

pub fn new( id: impl Into<String>, chain: Option<String>, store: Option<Arc<dyn ProgressStore>>, ) -> JobContext

pub fn detached() -> JobContext

A context for a job run outside the worker — a test calling handle directly. Reports go nowhere.

pub async fn progress(&self, percent: u8, stage: impl Into<String>)

Say how far along the job is.

Never fails the job. A progress store that is down should cost the user a stale bar, not a failed render — so the error is logged and swallowed here rather than returned.

pub fn keys(&self) -> Vec<String>

The job’s own key, and the chain’s when there is one.

Trait Implementations

impl Clone for JobContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.