Struct glean_core::metrics::StringMetric

pub struct StringMetric { /* fields omitted */ }

A string metric.

Record an Unicode string value with arbitrary content. Strings are length-limited to MAX_LENGTH_VALUE bytes.

Implementations

impl StringMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new string metric.

pub fn set<S: Into<String>>(&self, glean: &Glean, value: S)

Sets to the specified value.

Arguments

• glean - The Glean instance this metric belongs to.
• value - The string to set the metric to.

Notes

Truncates the value if it is longer than MAX_LENGTH_VALUE bytes and logs an error.

pub fn test_get_value(
    &self,
    glean: &Glean,
    storage_name: &str
) -> Option<String>

Test-only API (exported for FFI purposes).

Gets the currently stored value as a string.

This doesn’t clear the stored value.

Trait Implementations

impl Clone for StringMetric

fn clone(&self) -> StringMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringMetric

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MetricType for StringMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData

Access the stored metadata mutable

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded