Trait glean_core::traits::Event

pub trait Event {
    type Extra: ExtraKeys;

    fn record<M: Into<Option<Self::Extra>>>(&self, extra: M);
    fn test_get_value<'a, S: Into<Option<&'a str>>>(
        &self,
        ping_name: S
    ) -> Option<Vec<RecordedEvent>>;
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}

A description for the EventMetric type.

When changing this trait, make sure all the operations are implemented in the related type in ../metrics/.

Required Associated Types

type Extra: ExtraKeys

The type of the allowed extra keys for this event.

Required Methods

fn record<M: Into<Option<Self::Extra>>>(&self, extra: M)

Records an event.

Arguments

• extra - (optional) An object for the extra keys.

fn test_get_value<'a, S: Into<Option<&'a str>>>(
    &self,
    ping_name: S
) -> Option<Vec<RecordedEvent>>

Exported for test purposes.

Get the vector of currently stored events for this event metric.

This doesn’t clear the stored value.

Arguments

• ping_name - represents the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

• error - The type of error

Returns

The number of errors reported.

Implementors