Struct glean::private::TimespanMetric

pub struct TimespanMetric(_);

Developer-facing API for recording timespan 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 TimespanMetric

pub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> Self

The public constructor used by automatically generated metrics.

impl TimespanMetric

pub fn start(&self)

See glean_core::traits::Timespan::start

pub fn stop(&self)

See glean_core::traits::Timespan::stop

pub fn cancel(&self)

See glean_core::traits::Timespan::cancel

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

See glean_core::traits::Timespan::test_get_value

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

See glean_core::traits::Timespan::test_get_num_recorded_errors

Trait Implementations

impl Clone for TimespanMetric

fn clone(&self) -> TimespanMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Timespan for TimespanMetric

fn start(&self)

Starts tracking time for the provided metric.

fn stop(&self)

Stops tracking time for the provided metric. Sets the metric to the elapsed time.

fn cancel(&self)

Aborts a previous start call. No error is recorded if no start was called.

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

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.