Struct Enum

pub struct Enum<K>
where
    K: Flatten,
{ /* private fields */ }

Enumerated histograms.

Enumerated histogram generalize Count histograms to families of keys known at compile-time. They are useful, for instance, to know how often users have picked a specific choice from several, or how many times each kind of error has been triggered, etc.

With SerializationFormat::SimpleJson, these histograms are serialized as an array of numbers, in the order of enum values.

Implementations

impl<K> Enum<K>

where K: Flatten,

pub fn new(service: &Service, name: String) -> Enum<K>

Create a new Enum histogram with a given name.

Argument name is used as key when processing and exporting the data. Each name must be unique to the Service.

Panics

If name is already used by another histogram in service.

Trait Implementations

impl<K> Clone for Enum<K>

where K: Flatten,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K> Histogram<K> for Enum<K>

where K: Flatten,

fn record_cb<F>(&self, cb: F)

where F: FnOnce() -> Option<K>,

Record a value in this histogram, as provided by a callback.

fn record(&self, value: T)

Record a value in this histogram.