Struct glean_core::metrics::DatetimeMetric

pub struct DatetimeMetric { /* private fields */ }

A datetime metric.

Used to record an absolute date and time, such as the time the user first ran the application.

Implementations

impl DatetimeMetric

pub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> Self

Creates a new datetime metric.

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.

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.

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.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

• error - The type of error
• ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The number of errors reported.

Trait Implementations

impl Clone for DatetimeMetric

fn clone(&self) -> DatetimeMetric

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatetimeMetric

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl MetricType for DatetimeMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn with_name(&self, _name: String) -> Self where
    Self: Sized, 

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Self where
    Self: Sized, 

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded