Struct Metric 

pub struct Metric { /* private fields */ }

Stable metadata for one metric in a progress operation.

Implementations

impl Metric

pub fn new(id: &str, name: &str) -> Self

Creates metric metadata without a known total.

The ID and name are validated when the enclosing progress operation is started, so this constructor never panics.

pub const fn total(self, total: u64) -> Self

Records the total work for this metric.

The value is carried automatically by all future events from the operation that owns this metric.

pub fn id(&self) -> &str

Returns the metric’s stable ID.

pub fn name(&self) -> &str

Returns the metric’s display name.

pub const fn configured_total(&self) -> Option<u64>

Returns the configured total, if it is known.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl Eq for Metric

impl PartialEq for Metric

fn eq(&self, other: &Metric) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Metric