Struct MetricHandle 

pub struct MetricHandle { /* private fields */ }

Cloneable capability for one live metric owned by a progress operation.

All mutation methods are serialized by one CAS gate critical section. A handle remains readable after its progress operation closes, but rejects all later mutations.

Implementations

impl MetricHandle

pub fn id(&self) -> &str

Returns the stable metric ID.

pub fn name(&self) -> &str

Returns the stable metric display name.

pub fn start(&self, count: u64) -> Result<(), MetricError>

Moves work from the not-started state to the active state.

Errors

Returns a metric error when the transition violates aggregate state invariants or when the owning operation is closed.

pub fn complete(&self, count: u64) -> Result<(), MetricError>

Moves work from the active state to unclassified completion.

Errors

Returns a metric error when the transition violates aggregate state invariants or when the owning operation is closed.

pub fn succeed(&self, count: u64) -> Result<(), MetricError>

Moves work from the active state to the succeeded state.

Errors

Returns a metric error when the transition violates aggregate state invariants or when the owning operation is closed.

pub fn fail(&self, count: u64) -> Result<(), MetricError>

Moves work from the active state to the failed state.

Errors

Returns a metric error when the transition violates aggregate state invariants or when the owning operation is closed.

pub fn cancel(&self, count: u64) -> Result<(), MetricError>

Moves work from the active state to the cancelled state.

Errors

Returns a metric error when the transition violates aggregate state invariants or when the owning operation is closed.

pub fn apply_delta(&self, delta: MetricDelta) -> Result<(), MetricError>

Applies one atomic additive batch of lifecycle changes.

Errors

Returns a metric error when the delta exceeds active work, violates a configured total, overflows, or the owning operation is closed. The metric is unchanged whenever an error is returned.

pub fn snapshot(&self) -> MetricSnapshot

Returns one internally consistent immutable metric snapshot.

This read remains available after the owning operation closes.

Trait Implementations

impl Clone for MetricHandle

fn clone(&self) -> MetricHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.