Skip to main content

TaskContext

Struct TaskContext 

Source
pub struct TaskContext { /* private fields */ }
Expand description

Read-only task identity/configuration 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§

Source§

impl TaskContext

Source

pub fn task(&self) -> &Task

Borrows the complete immutable task declaration.

Source

pub fn key(&self) -> &TaskKey

Borrows the exact phase-qualified task key.

Source

pub fn id(&self) -> &TaskId

Borrows the phase-local task ID.

Source

pub fn kind(&self) -> &str

Borrows the task kind/namespace.

Source

pub fn configuration(&self) -> &TaskConfig

Borrows the configuration from which this task was generated.

Source

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

Borrows one fixed, swept, or explicit task parameter.

Source

pub fn decode_value<T>(&self, key: &str) -> Result<T, RuntimeError>

Decodes one required task parameter.

Source

pub fn progress_handle(&self) -> Option<&TaskProgress>

Borrows iterative progress for a progress task.

Source

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

Sets or replaces the target iteration of a progress task.

Source

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

Synchronizes a progress task to the authoritative scientific iteration.

Source

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

Synchronizes iteration and reports whether work should continue.

Source

pub fn activity_handle(&self) -> Option<&ActivityTask>

Borrows lifecycle-only reporting for an activity task.

Source

pub fn is_cancelled(&self) -> bool

Reports whether the runtime requested cooperative cancellation.

Source

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

Updates the human-readable task detail.

Source

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

Sends a task-scoped display message.

Trait Implementations§

Source§

impl Debug for TaskContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.