Struct glean::private::MemoryDistributionMetric
source · [−]pub struct MemoryDistributionMetric { /* private fields */ }
Expand description
A memory distribution metric.
Memory distributions are used to accumulate and store memory sizes.
Implementations
sourceimpl MemoryDistributionMetric
impl MemoryDistributionMetric
sourcepub fn new(
meta: CommonMetricData,
memory_unit: MemoryUnit
) -> MemoryDistributionMetric
pub fn new(
meta: CommonMetricData,
memory_unit: MemoryUnit
) -> MemoryDistributionMetric
Creates a new memory distribution metric.
sourcepub fn accumulate(&self, sample: i64)
pub fn accumulate(&self, sample: i64)
Accumulates the provided sample in the metric.
Arguments
sample
- The sample to be recorded by the metric. The sample is assumed to be in the configured memory unit of the metric.
Notes
Values bigger than 1 Terabyte (240 bytes) are truncated
and an ErrorType::InvalidValue
error is recorded.
sourcepub fn accumulate_samples(&self, samples: Vec<i64, Global>)
pub fn accumulate_samples(&self, samples: Vec<i64, Global>)
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.
Please note that this assumes that the provided samples are already in
the “unit” declared by the instance of the metric type (e.g. if the the
instance this method was called on is using MemoryUnit::Kilobyte
, then
samples
are assumed to be in that unit).
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.
Values bigger than 1 Terabyte (240 bytes) are truncated
and an ErrorType::InvalidValue
error is recorded.
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.
This doesn’t clear the stored value.
sourcepub fn test_get_num_recorded_errors(
&self,
error: ErrorType,
ping_name: Option<String>
) -> i32
pub fn test_get_num_recorded_errors(
&self,
error: ErrorType,
ping_name: Option<String>
) -> i32
Exported for test purposes.
Gets the number of recorded errors for the given metric and error type.
Arguments
error
- The type of errorping_name
- represents the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
Returns
The number of errors reported.
Trait Implementations
sourceimpl Clone for MemoryDistributionMetric
impl Clone for MemoryDistributionMetric
sourcefn clone(&self) -> MemoryDistributionMetric
fn clone(&self) -> MemoryDistributionMetric
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 Debug for MemoryDistributionMetric
impl Debug for MemoryDistributionMetric
sourceimpl MetricType for MemoryDistributionMetric
impl MetricType for MemoryDistributionMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_dynamic_label(&self, _label: String) -> Self
fn with_dynamic_label(&self, _label: String) -> Self
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 MemoryDistributionMetric
impl Send for MemoryDistributionMetric
impl Sync for MemoryDistributionMetric
impl Unpin for MemoryDistributionMetric
impl UnwindSafe for MemoryDistributionMetric
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