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
impl StringListMetric
sourcepub fn new(meta: CommonMetricData) -> Self
pub fn new(meta: CommonMetricData) -> Self
Creates a new string list metric.
sourcepub fn set(&self, values: Vec<String>)
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.
sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<Vec<String>>
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.
sourcepub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32
pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32
Exported for test purposes.
Gets the number of recorded errors for the given metric and error type.
Arguments
error
- The type of errorping_name
- represents the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
Returns
The number of errors reported.
Trait Implementations§
source§impl Clone for StringListMetric
impl Clone for StringListMetric
source§fn clone(&self) -> StringListMetric
fn clone(&self) -> StringListMetric
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for StringListMetric
impl Debug for StringListMetric
source§impl MetricType for StringListMetric
impl MetricType for StringListMetric
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more