Struct glean::private::EventMetric

pub struct EventMetric<K> { /* fields omitted */ }

Developer-facing API for recording event metrics.

Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.

Implementations

impl<K: ExtraKeys> EventMetric<K>

pub fn new(meta: CommonMetricData) -> Self

The public constructor used by automatically generated metrics.

pub fn record_with_time(&self, timestamp: u64, extra: HashMap<i32, String>)

Record a new event with a provided timestamp.

It's the caller's responsibility to ensure the timestamp comes from the same clock source. Use glean::get_timestamp_ms to get a valid timestamp.

impl<K: ExtraKeys> EventMetric<K>

pub fn record<M: Into<Option<HashMap<Self::Extra, String>>>>(&self, __arg1: M)

See traits::Event::record

pub fn test_get_value<'a, S: Into<Option<&'a str>>>(
    &self,
    __arg1: S
) -> Option<Vec<RecordedEvent>>

See traits::Event::test_get_value

pub fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
    &self,
    __arg1: ErrorType,
    __arg2: S
) -> i32

See traits::Event::test_get_num_recorded_errors

Trait Implementations

impl<K: Clone> Clone for EventMetric<K>

fn clone(&self) -> EventMetric<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: ExtraKeys> Event for EventMetric<K>

type Extra = K

The type of the allowed extra keys for this event.

fn record<M: Into<Option<HashMap<Self::Extra, String>>>>(&self, extra: M)

Records an event.

fn test_get_value<'a, S: Into<Option<&'a str>>>(
    &self,
    ping_name: S
) -> Option<Vec<RecordedEvent>>

Exported for test purposes.

fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
    &self,
    error: ErrorType,
    ping_name: S
) -> i32

Exported for test purposes.