Struct glean_core::metrics::StringListMetric[−][src]

pub struct StringListMetric { /* fields omitted */ }
Expand description

A string list metric.

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

Implementations

impl StringListMetric[src]

pub fn new(meta: CommonMetricData) -> Self[src]

Creates a new string list metric.

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

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>)[src]

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>>[src]

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>[src]

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[src]

fn clone(&self) -> StringListMetric[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for StringListMetric[src]

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

Formats the value using the given formatter. Read more

impl MetricType for StringListMetric[src]

fn meta(&self) -> &CommonMetricData[src]

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData[src]

Access the stored metadata mutable

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

Whether this metric should currently be recorded Read more

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.