Struct ProgressMetric 

pub struct ProgressMetric { /* private fields */ }

Describes one metric dimension reported by a progress operation.

The id is stable and machine-readable. It is stored in ProgressCounter values and therefore appears in JSON progress events. The name is human-readable and is intended for text reporters.

Implementations

impl ProgressMetric

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

Creates a metric definition.

Parameters

• id - Stable machine-readable metric identifier.
• name - Human-readable metric name.

Returns

A metric definition with id and name recorded.

pub fn id(&self) -> &str

Returns the stable metric identifier.

Returns

The machine-readable metric id.

pub fn name(&self) -> &str

Returns the human-readable metric name.

Returns

The display name for this metric.

Trait Implementations

impl Clone for ProgressMetric

fn clone(&self) -> ProgressMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressMetric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ProgressMetric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProgressMetric

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProgressMetric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProgressMetric

impl StructuralPartialEq for ProgressMetric