Struct glean::CommonMetricData

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.

Fields

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.

Implementations

impl CommonMetricData

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

Creates a new metadata object.

pub fn should_record(&self) -> bool

Whether this metric should be recorded.

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

The list of storages this metric should be recorded into.

Trait Implementations

impl Clone for CommonMetricData

fn clone(&self) -> CommonMetricData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommonMetricData

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

Formats the value using the given formatter.

impl Default for CommonMetricData

fn default() -> CommonMetricData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommonMetricData

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CommonMetricData, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CommonMetricData

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.