Struct TaskProgress 

pub struct TaskProgress { /* private fields */ }

Non-clone task-local progress handle.

Dropping a running handle without calling TaskProgress::complete or TaskProgress::fail marks the task failed, making ordinary ? returns safe without a separate cleanup branch.

Implementations

impl TaskProgress

pub fn is_cancelled(&self) -> bool

Reports whether the owning reporter requested cooperative termination.

pub fn identity(&self) -> &TaskIdentity

Borrows the exact parameter-derived task identity.

pub fn current_iteration(&self) -> u64

Returns the latest reported absolute simulation iteration.

pub fn target_iteration(&self) -> Option<u64>

Returns the known absolute target iteration, if one exists.

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

Sets or replaces the absolute target for this running task.

pub fn status(&self) -> TaskStatus

Returns this task’s current lifecycle status.

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

Synchronizes progress to an authoritative absolute simulation iteration.

The atomic update never allocates or locks. Regressions and movement beyond a known target are rejected without modifying the counter.

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

Synchronizes the authoritative iteration and applies the configured continuation target.

An indeterminate task returns true. A task with a target returns true below it and false exactly at it. Movement beyond the target or backwards is rejected through the same validation as Self::set_iteration.

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

Updates one infrequent human-readable detail such as evolving or validating. Detail updates may lock; iteration updates do not.

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

Sends one task-scoped message through the sole renderer.

pub fn complete(self, reason: Option<String>) -> Result<(), ReportingError>

Marks the complete task workflow successful and consumes this handle.

reason == None means the configured target must have been reached. Some(reason) records an intentional scientific early-completion reason and permits completion before that generic target.

pub fn fail(self, reason: impl Into<String>)

Marks the task failed, records a concise detail, and consumes the handle.

Trait Implementations

impl Debug for TaskProgress

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

Formats the value using the given formatter.

impl Drop for TaskProgress

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.