Struct Task 

pub struct Task { /* private fields */ }

First-class immutable task declaration owned by exactly one Phase.

Implementations

impl Task

pub fn one_shot<W>( id: impl Into<String>, label: impl Into<String>, workload: W, ) -> Self

where W: FnOnce(&TaskContext) -> TaskResult + Send + 'static,

Creates a one-shot task.

pub fn progress<W>( id: impl Into<String>, label: impl Into<String>, workload: W, ) -> Self

where W: FnOnce(&TaskContext) -> TaskResult + Send + 'static,

Creates a task that may report progress through its context.

pub fn one_shot_for_configuration<W>( category: impl Into<String>, configuration: &ResolvedConfiguration, workload: W, ) -> Self

where W: FnOnce(&TaskContext) -> TaskResult + Send + 'static,

Creates a one-shot task using the conventional configuration identity.

pub fn progress_for_configuration<W>( category: impl Into<String>, configuration: &ResolvedConfiguration, workload: W, ) -> Self

where W: FnOnce(&TaskContext) -> TaskResult + Send + 'static,

Creates a progress task using the conventional configuration identity.

pub fn completed(id: impl Into<String>, label: impl Into<String>) -> Self

Creates an application-verified task that is already satisfied.

pub fn category(self, category: impl Into<String>) -> Self

Sets the optional application-defined task category.

pub fn metadata(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Adds application-defined metadata used for inspection and selection.

pub fn with_configuration(self, configuration: &ResolvedConfiguration) -> Self

Attaches a complete resolved scientific configuration to task provenance.

pub fn with_project_paths(self, paths: &ProjectPaths) -> Self

Attaches the complete named project path table to task provenance.

pub fn key(&self) -> &TaskKey

Returns the exact phase-qualified task key.

pub fn id(&self) -> &TaskId

Returns the phase-local task ID.

pub fn category_name(&self) -> &str

Returns the application-defined task category.

pub fn label(&self) -> &str

Returns the automatically generated display label.

pub const fn mode(&self) -> TaskMode

Returns whether the task reports iterative progress or one-shot status.

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

Borrows one application-defined metadata value.

pub fn require_metadata(&self, key: &str) -> Result<&Value, StudyError>

Borrows one required task metadata value.

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

where T: DeserializeOwned,

Decodes one required task metadata value without first cloning its JSON tree.

pub fn metadata_iter(&self) -> impl Iterator<Item = (&str, &Value)> + '_

Iterates application-defined metadata.

Trait Implementations

impl Debug for Task

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

Formats the value using the given formatter.