Struct glean_core::metrics::NumeratorMetric
source · pub struct NumeratorMetric(/* private fields */);
Expand description
Developer-facing API for recording rate metrics with external denominators.
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§
source§impl NumeratorMetric
impl NumeratorMetric
sourcepub fn new(meta: CommonMetricData) -> Self
pub fn new(meta: CommonMetricData) -> Self
The public constructor used by automatically generated metrics.
sourcepub fn add_to_numerator(&self, amount: i32)
pub fn add_to_numerator(&self, amount: i32)
sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<Rate>
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<Rate>
Exported for test purposes.
Gets the currently stored value as a pair of integers.
Arguments
ping_name
- the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
This doesn’t clear the stored value.
sourcepub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32
pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32
Trait Implementations§
source§impl Clone for NumeratorMetric
impl Clone for NumeratorMetric
source§fn clone(&self) -> NumeratorMetric
fn clone(&self) -> NumeratorMetric
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl MetricType for NumeratorMetric
impl MetricType for NumeratorMetric
Auto Trait Implementations§
impl RefUnwindSafe for NumeratorMetric
impl Send for NumeratorMetric
impl Sync for NumeratorMetric
impl Unpin for NumeratorMetric
impl UnwindSafe for NumeratorMetric
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more