Struct glean::private::StringMetric
source · [−]pub struct StringMetric { /* private fields */ }
Expand description
A string metric.
Record an Unicode string value with arbitrary content.
Strings are length-limited to MAX_LENGTH_VALUE
bytes.
Implementations
sourceimpl StringMetric
impl StringMetric
sourcepub fn new(meta: CommonMetricData) -> StringMetric
pub fn new(meta: CommonMetricData) -> StringMetric
Creates a new string metric.
sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<String>
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<String>
Test-only API (exported for FFI purposes).
Gets the currently stored value as a string.
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 StringMetric
impl Clone for StringMetric
sourcefn clone(&self) -> StringMetric
fn clone(&self) -> StringMetric
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 StringMetric
impl Debug for StringMetric
sourceimpl MetricType for StringMetric
impl MetricType for StringMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_name(&self, name: String) -> StringMetric
fn with_name(&self, name: String) -> StringMetric
Create a new metric from this with a new name.
sourcefn with_dynamic_label(&self, label: String) -> StringMetric
fn with_dynamic_label(&self, label: String) -> StringMetric
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 StringMetric
impl Send for StringMetric
impl Sync for StringMetric
impl Unpin for StringMetric
impl UnwindSafe for StringMetric
Blanket Implementations
sourceimpl<T> AllowLabeled for T where
T: MetricType + Sealed,
impl<T> AllowLabeled for T where
T: MetricType + Sealed,
sourcefn new_labeled(meta: CommonMetricData) -> T
fn new_labeled(meta: CommonMetricData) -> T
Create a new labeled metric.
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