Enum metrics::Unit

pub enum Unit {
    Count,
    Percent,
    Seconds,
    Milliseconds,
    Microseconds,
    Nanoseconds,
    Tebibytes,
    Gigibytes,
    Mebibytes,
    Kibibytes,
    Bytes,
    TerabitsPerSecond,
    GigabitsPerSecond,
    MegabitsPerSecond,
    KilobitsPerSecond,
    BitsPerSecond,
    CountPerSecond,
}

Units for a given metric.

While metrics do not necessarily need to be tied to a particular unit to be recorded, some downstream systems natively support defining units and so they can be specified during registration.

Variants

Count

Count.

Percent

Percentage.

Seconds

Seconds.

One second is equal to 1000 milliseconds.

Milliseconds

Milliseconds.

One millisecond is equal to 1000 microseconds.

Microseconds

Microseconds.

One microsecond is equal to 1000 nanoseconds.

Nanoseconds

Nanoseconds.

Tebibytes

Tebibytes.

One tebibyte is equal to 1024 gigibytes.

Gigibytes

Gigibytes.

One gigibyte is equal to 1024 mebibytes.

Mebibytes

Mebibytes.

One mebibyte is equal to 1024 kibibytes.

Kibibytes

Kibibytes.

One kibibyte is equal to 1024 bytes.

Bytes

Bytes.

TerabitsPerSecond

Terabits per second.

One terabit is equal to 1000 gigabits.

GigabitsPerSecond

Gigabits per second.

One gigabit is equal to 1000 megabits.

MegabitsPerSecond

Megabits per second.

One megabit is equal to 1000 kilobits.

KilobitsPerSecond

Kilobits per second.

One kilobit is equal to 1000 bits.

BitsPerSecond

Bits per second.

CountPerSecond

Count per second.

Implementations

impl Unit

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

Gets the string form of this Unit.

pub fn as_canonical_label(&self) -> &'static str

Gets the canonical string label for the given unit.

For example, the canonical label for Seconds would be s, while for Nanoseconds, it would be ns.

Not all units have a meaningful display label and so some may be empty.

pub fn from_string(s: &str) -> Option<Unit>

Converts the string representation of a unit back into Unit if possible.

The value passed here should match the output of Unit::as_str.

pub fn is_time_based(&self) -> bool

Whether or not this unit relates to the measurement of time.

pub fn is_data_based(&self) -> bool

Whether or not this unit relates to the measurement of data.

pub fn is_data_rate_based(&self) -> bool

Whether or not this unit relates to the measurement of data rates.

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl PartialEq for Unit

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Unit

impl Eq for Unit

impl StructuralPartialEq for Unit