glean_core::traits

Trait MemoryDistribution

Source 
pub trait MemoryDistribution {
    // Required methods
    fn accumulate(&self, sample: u64);
    fn test_get_value<'a, S: Into<Option<&'a str>>>(
        &self,
        ping_name: S,
    ) -> Option<DistributionData>;
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}
Expand description

A description for the MemoryDistributionMetric type.

When changing this trait, make sure all the operations are implemented in the related type in ../metrics/.

Required Methods§

Source

fn accumulate(&self, sample: u64)

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.

Source

fn test_get_value<'a, S: Into<Option<&'a str>>>( &self, ping_name: S, ) -> Option<DistributionData>

Exported for test purposes.

Gets the currently stored value as a DistributionData of the serialized value.

This doesn’t clear the stored value.

§Arguments
  • ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.
Source

fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given error type.

§Arguments
  • error - The type of error
§Returns

The number of errors recorded.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§