Struct metrics_util::MetricKind

pub struct MetricKind(_);

Metric kind.

Useful for defining the kind of a metric in metadata, or creating a sum of metric kinds to describe allowed metric kinds for a specific operation, etc.

In order to use for defining multiple metric kinds, can be used in a bitmask fashion, as this type implements bitwise OR support, and checking for inclusion of a specific kind within another kind value can be checked via contains:

// Let's only match counters and histograms:
let mask = MetricKind::COUNTER | MetricKind::HISTOGRAM;

// And check to see if the kinds we have matches our mask:
assert!(!mask.contains(MetricKind::GAUGE));
assert!(mask.contains(MetricKind::COUNTER));

// There's even two handy versions to avoid extra typing:
let none_mask = MetricKind::NONE;
let all_mask = MetricKind::ALL;

assert!(!none_mask.contains(MetricKind::COUNTER));
assert!(!none_mask.contains(MetricKind::GAUGE));
assert!(!none_mask.contains(MetricKind::HISTOGRAM));
assert!(all_mask.contains(MetricKind::COUNTER));
assert!(all_mask.contains(MetricKind::GAUGE));
assert!(all_mask.contains(MetricKind::HISTOGRAM));

Implementations

impl MetricKind

pub const NONE: MetricKind

No metric kinds.

pub const COUNTER: MetricKind

The counter kind.

pub const GAUGE: MetricKind

The gauge kind.

pub const HISTOGRAM: MetricKind

The histogram kind.

pub const ALL: MetricKind

All metric kind.

pub fn contains(&self, other: MetricKind) -> bool

Whether or not this metric kind contains the specified kind.

Trait Implementations

impl BitOr<MetricKind> for MetricKind

type Output = Self

The resulting type after applying the | operator.

pub fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for MetricKind

pub fn clone(&self) -> MetricKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MetricKind

impl Debug for MetricKind

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

Formats the value using the given formatter.

impl Eq for MetricKind

impl Hash for MetricKind

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for MetricKind

pub fn cmp(&self, other: &MetricKind) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<MetricKind> for MetricKind

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

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

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

This method tests for !=.

impl PartialOrd<MetricKind> for MetricKind

pub fn partial_cmp(&self, other: &MetricKind) -> Option<Ordering>

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

pub fn lt(&self, other: &MetricKind) -> bool

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

pub fn le(&self, other: &MetricKind) -> bool

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

pub fn gt(&self, other: &MetricKind) -> bool

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

pub fn ge(&self, other: &MetricKind) -> bool

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

impl StructuralEq for MetricKind

impl StructuralPartialEq for MetricKind