Struct Progress 

pub struct Progress<'reporter> { /* private fields */ }

One started progress operation.

Terminal methods consume this value, preventing reports after a terminal phase and preventing duplicate terminal events in safe Rust.

Implementations

impl<'reporter> Progress<'reporter>

pub fn builder(reporter: &'reporter dyn Reporter) -> ProgressBuilder<'reporter>

Creates a builder borrowing one reporter.

pub fn builder_arc(reporter: Arc<dyn Reporter>) -> ProgressBuilder<'static>

Creates a builder that owns one shared reporter.

pub const fn is_enabled(&self) -> bool

Returns enablement sampled when this operation started.

pub fn elapsed(&self) -> Duration

Returns monotonic elapsed time since start().

pub fn metric(&self, metric_id: &str) -> Option<MetricHandle>

Returns a cloneable live metric selected by its stable ID.

pub fn report(&mut self) -> Result<(), EmissionError>

Immediately emits a Running event from current metric state.

pub fn report_if_due(&mut self) -> Result<(), EmissionError>

Emits a Running event only when the configured interval is due.

pub fn set_stage(&mut self, stage: Stage) -> Result<(), ConfigurationError>

Replaces stage metadata attached to subsequent events.

pub fn clear_stage(&mut self)

Removes stage metadata from subsequent events.

pub fn finish_unchecked(self) -> Result<Duration, TerminalError>

Consumes this operation and emits a successful terminal event without checking whether metric work is complete.

pub fn finish(self) -> Result<Duration, FinishError>

Consumes this operation and emits a successful terminal event only when no metric has active work and every known total has been completed.

pub fn finish_recoverable( self, ) -> Result<Duration, RecoverableFinishError<'reporter>>

Consumes this operation and emits a successful terminal event while preserving the operation when completion validation fails.

pub fn fail(self) -> Result<Duration, TerminalError>

Consumes this operation and emits a failed terminal event.

pub fn cancel(self) -> Result<Duration, TerminalError>

Consumes this operation and emits a cancelled terminal event.

pub fn spawn_auto_reporter<'scope, 'env>( &'scope mut self, scope: &'scope Scope<'scope, 'env>, ) -> AutoReporter<'scope, 'reporter>

where 'reporter: 'scope,

Spawns a scoped automatic Running reporter that exclusively borrows this operation.

Trait Implementations

impl Drop for Progress<'_>

fn drop(&mut self)

Closes live handles when a caller abandons an unfinished operation.

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.