Struct glean_core::metrics::CustomDistributionMetric
source · pub struct CustomDistributionMetric { /* private fields */ }
Expand description
A custom distribution metric.
Memory distributions are used to accumulate and store memory sizes.
Implementations§
source§impl CustomDistributionMetric
impl CustomDistributionMetric
sourcepub fn new(
meta: CommonMetricData,
range_min: i64,
range_max: i64,
bucket_count: i64,
histogram_type: HistogramType
) -> Self
pub fn new( meta: CommonMetricData, range_min: i64, range_max: i64, bucket_count: i64, histogram_type: HistogramType ) -> Self
Creates a new memory distribution metric.
sourcepub fn accumulate_samples(&self, samples: Vec<i64>)
pub fn accumulate_samples(&self, samples: Vec<i64>)
Accumulates the provided signed samples in the metric.
This is required so that the platform-specific code can provide us with
64 bit signed integers if no u64
comparable type is available. This
will take care of filtering and reporting errors for any provided negative
sample.
Arguments
samples
- The vector holding the samples to be recorded by the metric.
Notes
Discards any negative value in samples
and report an ErrorType::InvalidValue
for each of them.
sourcepub fn test_get_value(
&self,
ping_name: Option<String>
) -> Option<DistributionData>
pub fn test_get_value( &self, ping_name: Option<String> ) -> Option<DistributionData>
Test-only API (exported for FFI purposes).
Gets the currently stored value as an integer.
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 CustomDistributionMetric
impl Clone for CustomDistributionMetric
source§fn clone(&self) -> CustomDistributionMetric
fn clone(&self) -> CustomDistributionMetric
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 CustomDistributionMetric
impl Debug for CustomDistributionMetric
source§impl MetricType for CustomDistributionMetric
impl MetricType for CustomDistributionMetric
Auto Trait Implementations§
impl RefUnwindSafe for CustomDistributionMetric
impl Send for CustomDistributionMetric
impl Sync for CustomDistributionMetric
impl Unpin for CustomDistributionMetric
impl UnwindSafe for CustomDistributionMetric
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