Struct glean_core::RateMetric

pub struct RateMetric { /* private fields */ }

A rate metric.

Used to determine the proportion of things via two counts:

• A numerator defining the amount of times something happened,
• A denominator counting the amount of times someting could have happened.

Both numerator and denominator can only be incremented, not decremented.

Implementations

impl RateMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new rate metric.

pub fn add_to_numerator(&self, amount: i32)

Increases the numerator by amount.

Arguments

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

Notes

Logs an error if the amount is negative.

pub fn add_to_denominator(&self, amount: i32)

Increases the denominator by amount.

Arguments

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

Notes

Logs an error if the amount is negative.

pub fn test_get_value(&self, ping_name: Option<String>) -> Option<Rate>

Test-only API (exported for FFI purposes).

Gets the currently stored value as a pair of integers.

This doesn’t clear the stored value.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

• error - The type of error
• ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The number of errors reported.

Trait Implementations

impl Clone for RateMetric

fn clone(&self) -> RateMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RateMetric

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

Formats the value using the given formatter.

impl MetricType for RateMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn with_name(&self, _name: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a specific label.

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

Whether this metric should currently be recorded