Enum MetricComparison

#[non_exhaustive]
pub enum MetricComparison {
    Below,
    Above,
    Equal,
    BelowOrEqual,
    AboveOrEqual,
}

One exact numeric relationship used by the five threshold verbs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Below

The value must be strictly smaller than the threshold.

Above

The value must be strictly larger than the threshold.

Equal

The value must equal the threshold exactly.

BelowOrEqual

The value must be smaller than or equal to the threshold.

AboveOrEqual

The value must be larger than or equal to the threshold.

Implementations

impl MetricComparison

pub const ALL: [Self; 5]

All five numeric comparisons in stable fluent order.

pub const fn as_str(self) -> &'static str

Returns the stable comparison key.

pub fn is_satisfied(self, value: f64, threshold: f64) -> bool

Returns whether value satisfies this exact comparison against threshold.

Trait Implementations

impl Clone for MetricComparison

fn clone(&self) -> MetricComparison

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricComparison

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

Formats the value using the given formatter.

impl Display for MetricComparison

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

Formats the value using the given formatter.

impl Hash for MetricComparison

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MetricComparison

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MetricComparison

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for MetricComparison

impl Eq for MetricComparison

impl StructuralPartialEq for MetricComparison