Struct glean::private::BooleanMetric
source · [−]pub struct BooleanMetric { /* private fields */ }
Expand description
A boolean metric.
Records a simple flag.
Implementations
sourceimpl BooleanMetric
impl BooleanMetric
sourcepub fn new(meta: CommonMetricData) -> BooleanMetric
pub fn new(meta: CommonMetricData) -> BooleanMetric
Creates a new boolean metric.
sourcepub fn set(&self, value: bool)
pub fn set(&self, value: bool)
Sets to the specified boolean value.
Arguments
glean
- the Glean instance this metric belongs to.value
- the value to set.
sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<bool>
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<bool>
Test-only API (exported for FFI purposes).
Gets the currently stored value as an integer.
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 BooleanMetric
impl Clone for BooleanMetric
sourcefn clone(&self) -> BooleanMetric
fn clone(&self) -> BooleanMetric
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 BooleanMetric
impl Debug for BooleanMetric
sourceimpl MetricType for BooleanMetric
impl MetricType for BooleanMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_name(&self, name: String) -> BooleanMetric
fn with_name(&self, name: String) -> BooleanMetric
Create a new metric from this with a new name.
sourcefn with_dynamic_label(&self, label: String) -> BooleanMetric
fn with_dynamic_label(&self, label: String) -> BooleanMetric
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 BooleanMetric
impl Send for BooleanMetric
impl Sync for BooleanMetric
impl Unpin for BooleanMetric
impl UnwindSafe for BooleanMetric
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