Struct glean_core::metrics::JweMetric

pub struct JweMetric { /* fields omitted */ }

A JWE metric.

This metric will be work as a “transport” for JWE encrypted data.

The actual encrypti on is done somewhere else, Glean must only make sure the data is valid JWE.

Implementations

impl JweMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new JWE metric.

pub fn set_with_compact_representation<S: Into<String>>(
    &self,
    glean: &Glean,
    value: S
)

Sets to the specified JWE value.

Arguments

• glean - the Glean instance this metric belongs to.
• value - the compact representation of a JWE value.

pub fn set<S: Into<String>>(
    &self,
    glean: &Glean,
    header: S,
    key: S,
    init_vector: S,
    cipher_text: S,
    auth_tag: S
)

Builds a JWE value from its elements and set to it.

Arguments

• glean - the Glean instance this metric belongs to.
• header - the JWE Protected Header element.
• key - the JWE Encrypted Key element.
• init_vector - the JWE Initialization Vector element.
• cipher_text - the JWE Ciphertext element.
• auth_tag - the JWE Authentication Tag element.

pub fn test_get_value(
    &self,
    glean: &Glean,
    storage_name: &str
) -> Option<String>

Test-only API (exported for FFI purposes).

Gets the currently stored value as a string.

This doesn’t clear the stored value.

pub fn test_get_value_as_json_string(
    &self,
    glean: &Glean,
    storage_name: &str
) -> Option<String>

Test-only API (exported for FFI purposes).

Gets the currently stored JWE as a JSON String of the serialized value.

This doesn’t clear the stored value.

Trait Implementations

impl Clone for JweMetric

fn clone(&self) -> JweMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JweMetric

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

Formats the value using the given formatter.

impl MetricType for JweMetric

fn meta(&self) -> &CommonMetricData

Access the stored metadata

fn meta_mut(&mut self) -> &mut CommonMetricData

Access the stored metadata mutable

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

Whether this metric should currently be recorded