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
impl RateMetric
sourcepub fn new(meta: CommonMetricData) -> Self
pub fn new(meta: CommonMetricData) -> Self
Creates a new rate metric.
sourcepub fn add_to_numerator(&self, amount: i32)
pub fn add_to_numerator(&self, amount: i32)
sourcepub fn add_to_denominator(&self, amount: i32)
pub fn add_to_denominator(&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>
Test-only API (exported for FFI purposes).
Gets the currently stored value as a pair of integers.
This doesn’t clear the stored value.
§Arguments
ping_name
- the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
§Returns
The stored value or None
if nothing stored.
Trait Implementations§
source§impl Clone for RateMetric
impl Clone for RateMetric
source§fn clone(&self) -> RateMetric
fn clone(&self) -> RateMetric
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 Debug for RateMetric
impl Debug for RateMetric
source§impl<UT> LiftRef<UT> for RateMetric
impl<UT> LiftRef<UT> for RateMetric
type LiftType = Arc<RateMetric>
source§impl<UT> LowerError<UT> for RateMetric
impl<UT> LowerError<UT> for RateMetric
source§fn lower_error(obj: Self) -> RustBuffer
fn lower_error(obj: Self) -> RustBuffer
Lower this value for scaffolding function return Read more
source§impl<UT> LowerReturn<UT> for RateMetric
impl<UT> LowerReturn<UT> for RateMetric
source§type ReturnType = <Arc<RateMetric> as LowerReturn<UniFfiTag>>::ReturnType
type ReturnType = <Arc<RateMetric> as LowerReturn<UniFfiTag>>::ReturnType
The type that should be returned by scaffolding functions for this type. Read more
source§fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>
fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>
Lower the return value from an scaffolding call Read more
§fn handle_failed_lift(
error: LiftArgsError,
) -> Result<Self::ReturnType, RustCallError>
fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>
Lower the return value for failed argument lifts Read more
source§impl MallocSizeOf for RateMetric
impl MallocSizeOf for RateMetric
source§impl MetricType for RateMetric
impl MetricType for RateMetric
source§impl<UT> TypeId<UT> for RateMetric
impl<UT> TypeId<UT> for RateMetric
const TYPE_ID_META: MetadataBuffer = _
Auto Trait Implementations§
impl !Freeze for RateMetric
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> 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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
Create a new handle for an Arc value Read more
§unsafe fn clone_handle(handle: Handle) -> Handle
unsafe fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§unsafe fn consume_handle(handle: Handle) -> Arc<T>
unsafe fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
Read more