Struct glean::CommonMetricData[][src]

pub struct CommonMetricData {
    pub name: String,
    pub category: String,
    pub send_in_pings: Vec<String, Global>,
    pub lifetime: Lifetime,
    pub disabled: bool,
    pub dynamic_label: Option<String>,

The common set of data shared across all different metric types.


name: String

The metric's name.

category: String

The metric's category.

send_in_pings: Vec<String, Global>

List of ping names to include this metric in.

lifetime: Lifetime

The metric's lifetime.

disabled: bool

Whether or not the metric is disabled.

Disabled metrics are never recorded.

dynamic_label: Option<String>

Dynamic label.

When a LabeledMetric<T> factory creates the specific metric to be recorded to, dynamic labels are stored in the specific label so that we can validate them when the Glean singleton is available.


impl CommonMetricData[src]

pub fn new<A, B, C>(category: A, name: B, ping_name: C) -> CommonMetricData where
    C: Into<String>,
    A: Into<String>,
    B: Into<String>, 

Creates a new metadata object.

pub fn should_record(&self) -> bool[src]

Whether this metric should be recorded.

pub fn storage_names(&self) -> &[String][src]

The list of storages this metric should be recorded into.

Trait Implementations

impl Clone for CommonMetricData[src]

impl Debug for CommonMetricData[src]

impl Default for CommonMetricData[src]

Auto Trait Implementations

impl RefUnwindSafe for CommonMetricData[src]

impl Send for CommonMetricData[src]

impl Sync for CommonMetricData[src]

impl Unpin for CommonMetricData[src]

impl UnwindSafe for CommonMetricData[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

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

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.