Struct glean_core::metrics::StringListMetric

source · [−]

pub struct StringListMetric { /* private fields */ }

Expand description

A string list metric.

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

Implementations

source

impl StringListMetric

source

pub fn new(meta: CommonMetricData) -> Self

Creates a new string list metric.

source

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.

source

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.

source

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.

source

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

source

impl Clone for StringListMetric

source

fn clone(&self) -> StringListMetric

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for StringListMetric

source

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

Formats the value using the given formatter. Read more

source

impl MetricType for StringListMetric

source

fn meta(&self) -> &CommonMetricData

Access the stored metadata

source

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

Access the stored metadata mutable

source

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

Whether this metric should currently be recorded Read more

Auto Trait Implementations

impl RefUnwindSafe for StringListMetric

impl Send for StringListMetric

impl Sync for StringListMetric

impl Unpin for StringListMetric

impl UnwindSafe for StringListMetric

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

fn clone_into(&self, target: &mut T)

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

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct glean_core::metrics::StringListMetric

Implementations

impl StringListMetric

pub fn new(meta: CommonMetricData) -> Self

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

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

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

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

Trait Implementations

impl Clone for StringListMetric

fn clone(&self) -> StringListMetric

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

impl Debug for StringListMetric

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

impl MetricType for StringListMetric

fn meta(&self) -> &CommonMetricData

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

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

Auto Trait Implementations

impl RefUnwindSafe for StringListMetric

impl Send for StringListMetric

impl Sync for StringListMetric

impl Unpin for StringListMetric

impl UnwindSafe for StringListMetric

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,