[−][src]Struct glean_core::metrics::MemoryDistributionMetric
A memory distribution metric.
Memory distributions are used to accumulate and store memory sizes.
Implementations
impl MemoryDistributionMetric
[src]
pub fn new(meta: CommonMetricData, memory_unit: MemoryUnit) -> Self
[src]
Create a new memory distribution metric.
pub fn accumulate(&self, glean: &Glean, sample: u64)
[src]
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.
pub fn accumulate_samples_signed(&self, glean: &Glean, samples: Vec<i64>)
[src]
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 implementing metric type (e.g. if the
implementing class is a [MemoryDistributionMetricType] and 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.
pub fn test_get_value(
&self,
glean: &Glean,
storage_name: &str
) -> Option<DistributionData>
[src]
&self,
glean: &Glean,
storage_name: &str
) -> Option<DistributionData>
Test-only API (exported for FFI purposes).
Get the currently stored value as an integer.
This doesn't clear the stored value.
pub fn test_get_value_as_json_string(
&self,
glean: &Glean,
storage_name: &str
) -> Option<String>
[src]
&self,
glean: &Glean,
storage_name: &str
) -> Option<String>
Test-only API (exported for FFI purposes).
Get the currently-stored histogram as a JSON String of the serialized value.
This doesn't clear the stored value.
Trait Implementations
impl Debug for MemoryDistributionMetric
[src]
impl MetricType for MemoryDistributionMetric
[src]
fn meta(&self) -> &CommonMetricData
[src]
fn meta_mut(&mut self) -> &mut CommonMetricData
[src]
fn should_record(&self, glean: &Glean) -> bool
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,