Struct glean_core::metrics::MemoryDistributionMetric [−][src]
pub struct MemoryDistributionMetric { /* fields omitted */ }
Expand description
A memory distribution metric.
Memory distributions are used to accumulate and store memory sizes.
Implementations
Creates a new memory distribution metric.
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.
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.
Test-only API (exported for FFI purposes).
Gets the currently stored value as an integer.
This doesn’t clear the stored value.
Trait Implementations
Access the stored metadata
Access the stored metadata mutable
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