Struct metrics_util::MetricKindMask [−][src]
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
[src]
impl MetricKindMask
[src]pub const NONE: MetricKindMask
[src]
No metric kinds.
pub const COUNTER: MetricKindMask
[src]
The counter kind.
pub const GAUGE: MetricKindMask
[src]
The gauge kind.
pub const HISTOGRAM: MetricKindMask
[src]
The histogram kind.
pub const ALL: MetricKindMask
[src]
All metric kinds.
pub fn matches(&self, kind: MetricKind) -> bool
[src]
Whether or not this metric kind contains the specified kind.
Trait Implementations
impl BitOr<MetricKindMask> for MetricKindMask
[src]
impl BitOr<MetricKindMask> for MetricKindMask
[src]impl Clone for MetricKindMask
[src]
impl Clone for MetricKindMask
[src]fn clone(&self) -> MetricKindMask
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for MetricKindMask
[src]
impl Copy for MetricKindMask
[src]impl Eq for MetricKindMask
[src]
impl Eq for MetricKindMask
[src]impl Hash for MetricKindMask
[src]
impl Hash for MetricKindMask
[src]impl Ord for MetricKindMask
[src]
impl Ord for MetricKindMask
[src]impl PartialEq<MetricKindMask> for MetricKindMask
[src]
impl PartialEq<MetricKindMask> for MetricKindMask
[src]fn eq(&self, other: &MetricKindMask) -> bool
[src]
fn ne(&self, other: &MetricKindMask) -> bool
[src]
impl PartialOrd<MetricKindMask> for MetricKindMask
[src]
impl PartialOrd<MetricKindMask> for MetricKindMask
[src]fn partial_cmp(&self, other: &MetricKindMask) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
pub fn lt(&self, other: &Rhs) -> bool#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
pub fn le(&self, other: &Rhs) -> bool#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
pub fn gt(&self, other: &Rhs) -> bool#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
pub fn ge(&self, other: &Rhs) -> boolimpl StructuralEq for MetricKindMask
[src]
impl StructuralEq for MetricKindMask
[src]impl StructuralPartialEq for MetricKindMask
[src]
impl StructuralPartialEq for MetricKindMask
[src]Auto Trait Implementations
impl RefUnwindSafe for MetricKindMask
impl RefUnwindSafe for MetricKindMask
impl Send for MetricKindMask
impl Send for MetricKindMask
impl Sync for MetricKindMask
impl Sync for MetricKindMask
impl Unpin for MetricKindMask
impl Unpin for MetricKindMask
impl UnwindSafe for MetricKindMask
impl UnwindSafe for MetricKindMask