Struct TaskContext 

pub struct TaskContext { /* private fields */ }

Read-only task identity plus reporting and cancellation.

The context deliberately has no filesystem, storage, artifact, network, subprocess, or machine-resource operations. The workload owns all such effects directly.

Implementations

impl TaskContext

pub fn task(&self) -> &Task

Borrows the complete immutable task declaration.

pub fn key(&self) -> &TaskKey

Borrows the exact phase-qualified task key.

pub fn id(&self) -> &TaskId

Borrows the phase-local task ID.

pub fn category(&self) -> &str

Borrows the application-defined task category.

pub fn metadata(&self, key: &str) -> Option<&Value>

Borrows one application-defined metadata value.

pub fn decode_metadata<T>(&self, key: &str) -> Result<T, StudyError>

where T: DeserializeOwned,

Decodes one required metadata value.

pub fn set_target_iteration(&self, target: u64) -> Result<(), StudyError>

Sets or replaces the target iteration of a progress task.

pub fn set_iteration(&self, iteration: u64) -> Result<(), StudyError>

Synchronizes a progress task to the authoritative scientific iteration.

pub fn should_continue(&self, iteration: u64) -> Result<bool, StudyError>

Synchronizes iteration and reports whether work should continue.

pub fn is_cancelled(&self) -> bool

Reports whether the study requested cooperative cancellation.

pub fn set_detail(&self, detail: impl Into<String>)

Updates the human-readable task detail.

pub fn report(&self, message: impl Into<String>) -> Result<(), StudyError>

Sends a task-scoped display message.

Trait Implementations

impl Debug for TaskContext

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

Formats the value using the given formatter.