Struct glean::private::DatetimeMetric
source · [−]pub struct DatetimeMetric { /* private fields */ }
Expand description
A datetime metric.
Used to record an absolute date and time, such as the time the user first ran the application.
Implementations
sourceimpl DatetimeMetric
impl DatetimeMetric
sourcepub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> DatetimeMetric
pub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> DatetimeMetric
Creates a new datetime metric.
sourcepub fn set(&self, dt: Option<Datetime>)
pub fn set(&self, dt: Option<Datetime>)
Sets the metric to a date/time including the timezone offset.
Arguments
dt
- the optinal datetime to set this to. If missing the current date is used.
sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<Datetime>
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<Datetime>
Test-only API (exported for FFI purposes).
Gets the stored datetime value.
The precision of this value is truncated to the time_unit
precision.
Arguments
glean
- the Glean instance this metric belongs to.storage_name
- the storage name to look into.
Returns
The stored value or None
if nothing stored.
sourcepub fn test_get_value_as_string(
&self,
ping_name: Option<String>
) -> Option<String>
pub fn test_get_value_as_string(
&self,
ping_name: Option<String>
) -> Option<String>
Test-only API (exported for FFI purposes).
Gets the stored datetime value, formatted as an ISO8601 string.
The precision of this value is truncated to the time_unit
precision.
Arguments
glean
- the Glean instance this metric belongs to.storage_name
- the storage name to look into.
Returns
The stored value or None
if nothing stored.
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 DatetimeMetric
impl Clone for DatetimeMetric
sourcefn clone(&self) -> DatetimeMetric
fn clone(&self) -> DatetimeMetric
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 DatetimeMetric
impl Debug for DatetimeMetric
sourceimpl MetricType for DatetimeMetric
impl MetricType for DatetimeMetric
sourcefn meta(&self) -> &CommonMetricData
fn meta(&self) -> &CommonMetricData
Access the stored metadata
sourcefn with_dynamic_label(&self, _label: String) -> Self
fn with_dynamic_label(&self, _label: String) -> Self
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 DatetimeMetric
impl Send for DatetimeMetric
impl Sync for DatetimeMetric
impl Unpin for DatetimeMetric
impl UnwindSafe for DatetimeMetric
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