Struct glean_core::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
sourceimpl 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,
ping_name: Option<String>
) -> i32
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 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
sourceimpl Clone for StringListMetric
impl Clone for StringListMetric
sourcefn clone(&self) -> StringListMetric
fn clone(&self) -> StringListMetric
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StringListMetric
impl Debug for StringListMetric
sourceimpl MetricType for StringListMetric
impl MetricType for StringListMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_name(&self, _name: String) -> Self where
Self: Sized,
fn with_name(&self, _name: String) -> Self where
Self: Sized,
Create a new metric from this with a new name.
sourcefn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
fn with_dynamic_label(&self, _label: String) -> Self where
Self: Sized,
Create a new metric from this with a specific label.
sourcefn should_record(&self, glean: &Glean) -> bool
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more