Struct metrics_util::MetricKindMask

pub struct MetricKindMask(_);

Metric kind mask.

Useful for matching against a kind, or kinds, of metrics.

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 matches:

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

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

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

assert!(!none_mask.matches(MetricKind::Counter));
assert!(!none_mask.matches(MetricKind::Gauge));
assert!(!none_mask.matches(MetricKind::Histogram));
assert!(all_mask.matches(MetricKind::Counter));
assert!(all_mask.matches(MetricKind::Gauge));
assert!(all_mask.matches(MetricKind::Histogram));

Implementations

impl MetricKindMask

pub const NONE: MetricKindMask

No metric kinds.

pub const COUNTER: MetricKindMask

The counter kind.

pub const GAUGE: MetricKindMask

The gauge kind.

pub const HISTOGRAM: MetricKindMask

The histogram kind.

pub const ALL: MetricKindMask

All metric kinds.

pub fn matches(&self, kind: MetricKind) -> bool

Whether or not this metric kind contains the specified kind.

Trait Implementations

impl BitOr<MetricKindMask> for MetricKindMask

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for MetricKindMask

fn clone(&self) -> MetricKindMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MetricKindMask

impl Debug for MetricKindMask

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

Formats the value using the given formatter.

impl Eq for MetricKindMask

impl Hash for MetricKindMask

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 MetricKindMask

fn cmp(&self, other: &MetricKindMask) -> 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<MetricKindMask> for MetricKindMask

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

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

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

This method tests for !=.

impl PartialOrd<MetricKindMask> for MetricKindMask

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for MetricKindMask

impl StructuralPartialEq for MetricKindMask