Struct glean_core::metrics::NumeratorMetric
source · [−]pub struct NumeratorMetric(_);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
sourceimpl 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.
Trait Implementations
sourceimpl Clone for NumeratorMetric
impl Clone for NumeratorMetric
sourcefn clone(&self) -> NumeratorMetric
fn clone(&self) -> NumeratorMetric
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
sourceimpl MetricType for NumeratorMetric
impl MetricType for NumeratorMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_name(&self, _name: String) -> Self where
Self: Sized,
fn with_name(&self, _name: String) -> Self where
Self: Sized,
Create a new metric from this with a new name.
sourcefn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
fn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
Create a new metric from this with a specific label.
sourcefn should_record(&self, glean: &Glean) -> bool
fn should_record(&self, glean: &Glean) -> bool
Whether this metric should currently be recorded Read more
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more