Struct glean::private::ObjectMetric

pub struct ObjectMetric<K> { /* private fields */ }

Developer-facing API for recording object metrics.

Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.

Implementations

impl<K: ObjectSerialize> ObjectMetric<K>

pub fn new(meta: CommonMetricData) -> Self

The public constructor used by automatically generated metrics.

pub fn set(&self, object: K)

Sets to the specified structure.

Arguments

• object - the object to set.

pub fn set_string(&self, object: String)

Sets to the specified structure.

Parses the passed JSON string. If it can’t be parsed into a valid object it records an invalid value error.

Arguments

• object - JSON representation of the object to set.

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

Exported for test purposes.

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

Arguments

• error - The type of error

Returns

The number of errors reported.

Trait Implementations

impl<K: Clone> Clone for ObjectMetric<K>

fn clone(&self) -> ObjectMetric<K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K> MallocSizeOf for ObjectMetric<K>

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl<'a, K> MetricIdentifier<'a> for ObjectMetric<K>

fn get_identifiers(&'a self) -> (&'a str, &'a str, Option<&'a str>)

Retrieve the category, name and (maybe) label of the metric

impl<K> TestGetValue for ObjectMetric<K>

fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue>

Test-only API (exported for FFI purposes).

Gets the currently stored value as JSON-encoded string.

This doesn’t clear the stored value.

type Output = Value

The output type of test_get_value