Struct prometrics::metric::MetricName

pub struct MetricName { /* fields omitted */ }

Metric name.

A metric name is a sequence of characters that match the regex [a-zA-Z_:][a-zA-Z0-9_:]*. It consists of three parts: {namespace}_{subsystem}_{name} of which only the name is mandatory.

References

• Metric name and labels
• Metric names

Methods

impl MetricName

pub fn namespace(&self) -> Option<&str>

Returns the namespace part of this.

pub fn subsystem(&self) -> Option<&str>

Returns the subsystem part of this.

pub fn name(&self) -> &str

Returns the name part of this.

Trait Implementations

impl Debug for MetricName

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for MetricName

fn clone(&self) -> MetricName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for MetricName

fn eq(&self, __arg_0: &MetricName) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &MetricName) -> bool

This method tests for !=.

impl Eq for MetricName

impl PartialOrd for MetricName

fn partial_cmp(&self, __arg_0: &MetricName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &MetricName) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &MetricName) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &MetricName) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &MetricName) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for MetricName

fn cmp(&self, __arg_0: &MetricName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for MetricName

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Display for MetricName

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

Formats the value using the given formatter.