Struct Metric 

#[non_exhaustive]
pub struct Metric {
    pub name: String,
    pub value: Option<Value>,
    /* private fields */
}

Progress metric is (string, int|float|string) pair.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Required. Metric name, e.g., “nodes total”, “percent done”.

value: Option<Value>

Strictly one of the values is required.

Implementations

impl Metric

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_value<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of value.

Note that all the setters affecting value are mutually exclusive.

pub fn int_value(&self) -> Option<&i64>

The value of value if it holds a IntValue, None if the field is not set or holds a different branch.

pub fn set_int_value<T: Into<i64>>(self, v: T) -> Self

Sets the value of value to hold a IntValue.

Note that all the setters affecting value are mutually exclusive.

pub fn double_value(&self) -> Option<&f64>

The value of value if it holds a DoubleValue, None if the field is not set or holds a different branch.

pub fn set_double_value<T: Into<f64>>(self, v: T) -> Self

Sets the value of value to hold a DoubleValue.

Note that all the setters affecting value are mutually exclusive.

pub fn string_value(&self) -> Option<&String>

The value of value if it holds a StringValue, None if the field is not set or holds a different branch.

pub fn set_string_value<T: Into<String>>(self, v: T) -> Self

Sets the value of value to hold a StringValue.

Note that all the setters affecting value are mutually exclusive.

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 Default for Metric

fn default() -> Metric

Returns the “default value” for a type.

impl Message for Metric

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Metric

fn eq(&self, other: &Metric) -> 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 StructuralPartialEq for Metric