Enum relay_metrics::MetricUnit

pub enum MetricUnit {
    Duration(DurationUnit),
    Information(InformationUnit),
    Fraction(FractionUnit),
    Custom(CustomUnit),
    None,
}

The unit of measurement of a metric value.

Units augment metric values by giving them a magnitude and semantics. There are certain types of units that are subdivided in their precision, such as the DurationUnit for time measurements.

Units and their precisions are uniquely represented by a string identifier.

Variants

Duration(DurationUnit)

A time duration, defaulting to "millisecond".

Information(InformationUnit)

Size of information derived from bytes, defaulting to "byte".

Fraction(FractionUnit)

Fractions such as percentages, defaulting to "ratio".

Custom(CustomUnit)

User-defined units without built-in conversion or default.

None

Untyped value without a unit ("").

Implementations

impl MetricUnit

pub fn is_none(&self) -> bool

Returns true if the metric_unit is None.

pub fn as_str(&self) -> &str

Returns the string representation for this metric unit.

Trait Implementations

impl Clone for MetricUnit

fn clone(&self) -> MetricUnit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricUnit

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

Formats the value using the given formatter.

impl Default for MetricUnit

fn default() -> MetricUnit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricUnit

fn deserialize<D>( deserializer: D ) -> Result<MetricUnit, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MetricUnit

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

Formats the value using the given formatter.

impl Empty for MetricUnit

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn is_deep_empty(&self) -> bool

Returns whether this value is empty or all of its descendants are empty.

impl FromStr for MetricUnit

type Err = ParseMetricUnitError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<MetricUnit, <MetricUnit as FromStr>::Err>

Parses a string s to return a value of this type.

impl FromValue for MetricUnit

fn from_value(value: Annotated<Value>) -> Annotated<MetricUnit>

Creates a meta structure from an annotated boxed value.

impl Hash for MetricUnit

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

where __H: Hasher,

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 IntoValue for MetricUnit

fn into_value(self) -> Value

where MetricUnit: Sized,

Boxes the meta structure back into a value.

fn serialize_payload<S>( &self, s: S, _behavior: SkipSerialization ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where MetricUnit: Sized, S: Serializer,

Efficiently serializes the payload directly.

fn extract_child_meta(&self) -> BTreeMap<String, MetaTree>

where Self: Sized,

Extracts children meta map out of a value.

fn extract_meta_tree(value: &Annotated<Self>) -> MetaTree

where Self: Sized,

Extracts the meta tree out of annotated value.

impl JsonSchema for MetricUnit

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MetricUnit

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

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MetricUnit

impl Eq for MetricUnit

impl StructuralPartialEq for MetricUnit