Enum Unit 

pub enum Unit {
    None,
    Seconds,
    Milliseconds,
    Microseconds,
    Nanoseconds,
    Bytes,
    Kilobytes,
    Megabytes,
    Gigabytes,
    Percent,
    Ratio,
    Custom(&'static str),
}

Unit of measurement for a metric value.

Exporters use the unit for two things:

1. Emit OpenMetrics # UNIT lines and Prometheus name suffixes (_seconds, _bytes, _total, …).
2. Normalise values where appropriate (e.g., Timer values exported in seconds rather than nanoseconds).

Unit::Custom carries a free-form static string for units not enumerated here.

Variants

None

No unit / dimensionless quantity.

Seconds

SI seconds.

Milliseconds

SI milliseconds.

Microseconds

SI microseconds.

Nanoseconds

SI nanoseconds.

Bytes

Bytes (binary, 1024-scale used by the MemoryGauge helpers).

Kilobytes

Kilobytes (1024 bytes).

Megabytes

Megabytes (1024² bytes).

Gigabytes

Gigabytes (1024³ bytes).

Percent

Percentage 0..=100.

Ratio

Ratio 0.0..=1.0.

Custom(&'static str)

Free-form unit name (e.g., "requests", "connections").

Implementations

impl Unit

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

Lower-case Prometheus/OpenMetrics unit name. Returns "" for Unit::None.

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a duplicate 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 Default for Unit

fn default() -> Unit

Returns the “default value” for a type.

impl Hash for Unit

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 PartialEq for Unit

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

impl Eq for Unit

impl StructuralPartialEq for Unit