glean_core::traits

Trait Counter

Source 
pub trait Counter {
    // Required methods
    fn add(&self, amount: i32);
    fn test_get_value<'a, S: Into<Option<&'a str>>>(
        &self,
        ping_name: S,
    ) -> Option<i32>;
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}
Expand description

A description for the CounterMetric type.

When changing this trait, make sure all the operations are implemented in the related type in ../metrics/.

Required Methods§

Source

fn add(&self, amount: i32)

Increases the counter by amount.

§Arguments
  • amount - The amount to increase by. Should be positive.
§Notes

Logs an error if the amount is 0 or negative.

Source

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

Exported for test purposes.

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

§Arguments
  • ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.
Source

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
§Returns

The number of errors reported.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§