Struct glean_core::metrics::StringListMetric

pub struct StringListMetric { /* private fields */ }

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(&self, value: String)

Adds a new string to the list.

Arguments

• 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, values: Vec<String>)

Sets to a specific list of strings.

Arguments

• 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, ping_name: Option<String>) -> 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_num_recorded_errors(
    &self,
    error: ErrorType,
    ping_name: Option<String>
) -> i32

Exported for test purposes.

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

Arguments

• error - The type of error
• ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The number of errors reported.

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 with_name(&self, _name: String) -> Self where
    Self: Sized, 

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Self where
    Self: Sized, 

Create a new metric from this with a specific label.

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

Whether this metric should currently be recorded