Struct glean_core::metrics::CounterMetric

pub struct CounterMetric { /* fields omitted */ }

A counter metric.

Used to count things. The value can only be incremented, not decremented.

Implementations

impl CounterMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new counter metric.

pub fn add(&self, glean: &Glean, amount: i32)

Increases the counter by amount.

Arguments

• glean - The Glean instance this metric belongs to.
• amount - The amount to increase by. Should be positive.

Notes

Logs an error if the amount is 0 or negative.

pub fn test_get_value(&self, glean: &Glean, storage_name: &str) -> Option<i32>

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

Trait Implementations

impl Clone for CounterMetric

fn clone(&self) -> CounterMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CounterMetric

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

Formats the value using the given formatter.

impl MetricType for CounterMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData

Access the stored metadata mutable

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded