[−][src]Struct glean::private::StringMetric
This implements the developer facing API for recording string metrics.
Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.
Implementations
impl StringMetric
[src]
pub fn new(meta: CommonMetricData) -> Self
[src]
The public constructor used by automatically generated metrics.
impl StringMetric
[src]
pub fn set<S: Into<String>>(&self, __arg1: S)
[src]
Sets to the specified value.
Arguments
value
- The string to set the metric to.
Notes
Truncates the value if it is longer than MAX_STRING_LENGTH
bytes and logs an error.
pub fn test_get_value<'a, S: Into<Option<&'a str>>>(
&self,
__arg1: S
) -> Option<String>
[src]
&self,
__arg1: S
) -> Option<String>
Exported for test purposes.
Gets the currently stored value as a string.
This doesn't clear the stored value.
Arguments
ping_name
- represents the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
pub fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
&self,
__arg1: ErrorType,
__arg2: S
) -> i32
[src]
&self,
__arg1: ErrorType,
__arg2: S
) -> 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
impl Clone for StringMetric
[src]
fn clone(&self) -> StringMetric
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl String for StringMetric
[src]
fn set<S: Into<String>>(&self, value: S)
[src]
Sets to the specified value.
Arguments
value
- The string to set the metric to.
Notes
Truncates the value if it is longer than MAX_STRING_LENGTH
bytes and logs an error.
fn test_get_value<'a, S: Into<Option<&'a str>>>(
&self,
ping_name: S
) -> Option<String>
[src]
&self,
ping_name: S
) -> Option<String>
Exported for test purposes.
Gets the currently stored value as a string.
This doesn't clear the stored value.
Arguments
ping_name
- represents the optional name of the ping to retrieve the metric for. Defaults to the first value insend_in_pings
.
fn test_get_num_recorded_errors<'a, S: Into<Option<&'a str>>>(
&self,
error: ErrorType,
ping_name: S
) -> i32
[src]
&self,
error: ErrorType,
ping_name: S
) -> 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.
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
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]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,