Struct glean_core::metrics::StringListMetric

pub struct StringListMetric { /* fields omitted */ }

A string list metric.

This allows appending a string value with arbitrary content to a list.

Implementations

impl StringListMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new string list metric.

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

Adds a new string to the list.

Arguments

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

Notes

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

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

Sets to a specific list of strings.

Arguments

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

Notes

If passed an empty list, records an error and returns.

Truncates the list if it is longer than MAX_LIST_LENGTH and logs an error.

Truncates any value in the list if it is longer than MAX_STRING_LENGTH and logs an error.

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

Test-only API (exported for FFI purposes).

Gets the currently-stored values.

This doesn’t clear the stored value.

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

Test-only API (exported for FFI purposes).

Gets the currently-stored values as a JSON String of the format [“string1”, “string2”, …]

This doesn’t clear the stored value.

Trait Implementations

impl Clone for StringListMetric

fn clone(&self) -> StringListMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringListMetric

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

Formats the value using the given formatter.

impl MetricType for StringListMetric

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