[−][src]Struct glean_core::metrics::EventMetric
An event metric.
Events allow recording of e.g. individual occurences of user actions, say every time a view was open and from where. Each time you record an event, it records a timestamp, the event's name and a set of custom values.
Methods
impl EventMetric
[src]
pub fn new(meta: CommonMetricData, allowed_extra_keys: Vec<String>) -> Self
[src]
Create a new event metric.
pub fn record<M: Into<Option<HashMap<i32, String>>>>(
&self,
glean: &Glean,
timestamp: u64,
extra: M
)
[src]
&self,
glean: &Glean,
timestamp: u64,
extra: M
)
Record an event.
Arguments
glean
- The Glean instance this metric belongs to.timestamp
- A monotonically increasing timestamp, in milliseconds. This must be provided since the actual recording of the event may happen some time later than the moment the event occurred.extra
- A HashMap of (key, value) pairs. The key is an index into the metric'sallowed_extra_keys
vector where the key's string is looked up. If any key index is out of range, an error is reported and no event is recorded.
pub fn test_has_value(&self, glean: &Glean, store_name: &str) -> bool
[src]
Test-only API (exported for FFI purposes).
Test whether there are currently stored events for this event metric.
This doesn't clear the stored value.
pub fn test_get_value(
&self,
glean: &Glean,
store_name: &str
) -> Option<Vec<RecordedEventData>>
[src]
&self,
glean: &Glean,
store_name: &str
) -> Option<Vec<RecordedEventData>>
Test-only API (exported for FFI purposes).
Get the vector of currently stored events for this event metric.
This doesn't clear the stored value.
pub fn test_get_value_as_json_string(
&self,
glean: &Glean,
store_name: &str
) -> String
[src]
&self,
glean: &Glean,
store_name: &str
) -> String
Test-only API (exported for FFI purposes).
Get the currently stored events for this event metric as a JSON-encoded string.
This doesn't clear the stored value.
Trait Implementations
impl Clone for EventMetric
[src]
fn clone(&self) -> EventMetric
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for EventMetric
[src]
impl MetricType for EventMetric
[src]
fn meta(&self) -> &CommonMetricData
[src]
fn meta_mut(&mut self) -> &mut CommonMetricData
[src]
fn should_record(&self, glean: &Glean) -> bool
[src]
Auto Trait Implementations
impl RefUnwindSafe for EventMetric
impl Send for EventMetric
impl Sync for EventMetric
impl Unpin for EventMetric
impl UnwindSafe for EventMetric
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,