Enum Metric

pub enum Metric {
    Boolean(bool),
    Counter(i32),
    CustomDistributionExponential(Histogram<PrecomputedExponential>),
    CustomDistributionLinear(Histogram<PrecomputedLinear>),
    Datetime(DateTime<FixedOffset>, TimeUnit),
    Experiment(RecordedExperiment),
    Quantity(i64),
    String(String),
    StringList(Vec<String>),
    Uuid(String),
    Timespan(Duration, TimeUnit),
    TimingDistribution(Histogram<Functional>),
    MemoryDistribution(Histogram<Functional>),
    Jwe(String),
    Rate(i32, i32),
    Url(String),
    Text(String),
    Object(String),
}

The available metrics.

This is the in-memory and persisted layout of a metric.

Note

The order of metrics in this enum is important, as it is used for serialization. Do not reorder the variants.

Any new metric must be added at the end.

Variants

Boolean(bool)

A boolean metric. See BooleanMetric for more information.

Counter(i32)

A counter metric. See CounterMetric for more information.

CustomDistributionExponential(Histogram<PrecomputedExponential>)

A custom distribution with precomputed exponential bucketing. See CustomDistributionMetric for more information.

CustomDistributionLinear(Histogram<PrecomputedLinear>)

A custom distribution with precomputed linear bucketing. See CustomDistributionMetric for more information.

Datetime(DateTime<FixedOffset>, TimeUnit)

A datetime metric. See DatetimeMetric for more information.

Experiment(RecordedExperiment)

An experiment metric. See ExperimentMetric for more information.

Quantity(i64)

A quantity metric. See QuantityMetric for more information.

String(String)

A string metric. See StringMetric for more information.

StringList(Vec<String>)

A string list metric. See StringListMetric for more information.

Uuid(String)

A UUID metric. See UuidMetric for more information.

Timespan(Duration, TimeUnit)

A timespan metric. See TimespanMetric for more information.

TimingDistribution(Histogram<Functional>)

A timing distribution. See TimingDistributionMetric for more information.

MemoryDistribution(Histogram<Functional>)

A memory distribution. See MemoryDistributionMetric for more information.

Jwe(String)

DEPRECATED: A JWE metric.. Note: This variant MUST NOT be removed to avoid backwards-incompatible changes to the serialization. This type has no underlying implementation anymore.

Rate(i32, i32)

A rate metric. See RateMetric for more information.

Url(String)

A URL metric. See UrlMetric for more information.

Text(String)

A Text metric. See TextMetric for more information.

Object(String)

An Object metric. See ObjectMetric for more information.

Implementations

impl Metric

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

Gets the ping section the metric fits into.

This determines the section of the ping to place the metric data in when assembling the ping payload.

pub fn as_json(&self) -> JsonValue

The JSON representation of the metric’s data

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Metric

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Metric