Struct glean_core::metrics::DatetimeMetric[−][src]

pub struct DatetimeMetric { /* fields omitted */ }
Expand description

A datetime metric.

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

Implementations

impl DatetimeMetric[src]

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

Creates a new datetime metric.

pub fn set_with_details(
    &self,
    glean: &Glean,
    year: i32,
    month: u32,
    day: u32,
    hour: u32,
    minute: u32,
    second: u32,
    nano: u32,
    offset_seconds: i32
)[src]

Sets the metric to a date/time including the timezone offset.

Arguments

  • glean - the Glean instance this metric belongs to.
  • year - the year to set the metric to.
  • month - the month to set the metric to (1-12).
  • day - the day to set the metric to (1-based).
  • hour - the hour to set the metric to.
  • minute - the minute to set the metric to.
  • second - the second to set the metric to.
  • nano - the nanosecond fraction to the last whole second.
  • offset_seconds - the timezone difference, in seconds, for the Eastern Hemisphere. Negative seconds mean Western Hemisphere.

pub fn set(&self, glean: &Glean, value: Option<Datetime>)[src]

Sets the metric to a date/time which including the timezone offset.

Arguments

  • glean - the Glean instance this metric belongs to.
  • value - Some DateTime value, with offset, to set the metric to. If none, the current local time is used.

pub fn test_get_value(
    &self,
    glean: &Glean,
    storage_name: &str
) -> Option<Datetime>[src]

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,
    glean: &Glean,
    storage_name: &str
) -> Option<String>[src]

Test-only API (exported for FFI purposes).

Gets the currently stored value as a String.

The precision of this value is truncated to the time_unit precision.

This doesn’t clear the stored value.

Trait Implementations

impl Debug for DatetimeMetric[src]

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

Formats the value using the given formatter. Read more

impl MetricType for DatetimeMetric[src]

fn meta(&self) -> &CommonMetricData[src]

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData[src]

Access the stored metadata mutable

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

Whether this metric should currently be recorded Read more

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

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]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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]

Performs the conversion.