Struct glean_core::metrics::RateMetric

source · [−]

pub struct RateMetric { /* private fields */ }

Expand description

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

source

impl RateMetric

source

pub fn new(meta: CommonMetricData) -> Self

Creates a new rate metric.

source

pub fn add_to_numerator(&self, glean: &Glean, 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.

source

pub fn add_to_denominator(&self, glean: &Glean, 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.

source

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

Test-only API (exported for FFI purposes).

Gets the currently stored value as a pair of integers.

This doesn’t clear the stored value.

Trait Implementations

source

impl Clone for RateMetric

source

fn clone(&self) -> RateMetric

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for RateMetric

source

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

Formats the value using the given formatter. Read more

source

impl MetricType for RateMetric

source

fn meta(&self) -> &CommonMetricData

Access the stored metadata

source

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

Access the stored metadata mutable

source

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

Whether this metric should currently be recorded Read more

Auto Trait Implementations

impl RefUnwindSafe for RateMetric

impl Send for RateMetric

impl Sync for RateMetric

impl Unpin for RateMetric

impl UnwindSafe for RateMetric

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct glean_core::metrics::RateMetric

Implementations

impl RateMetric

pub fn new(meta: CommonMetricData) -> Self

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

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

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

Trait Implementations

impl Clone for RateMetric

fn clone(&self) -> RateMetric

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

impl Debug for RateMetric

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

impl MetricType for RateMetric

fn meta(&self) -> &CommonMetricData

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

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

Auto Trait Implementations

impl RefUnwindSafe for RateMetric

impl Send for RateMetric

impl Sync for RateMetric

impl Unpin for RateMetric

impl UnwindSafe for RateMetric

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,