Trait glean::traits::Event[−][src]

pub trait Event {
    type Extra: ExtraKeys;
    pub fn record<M>(&self, extra: M)
    where
        M: Into<Option<HashMap<Self::Extra, String, RandomState>>>;

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

    pub fn test_get_num_recorded_errors<'a, S>(
        &self, 
        error: ErrorType, 
        ping_name: S
    ) -> i32
    where
        S: Into<Option<&'a str>>;
}

A description for the EventMetric type.

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

Associated Types

type Extra: ExtraKeys[src]

The type of the allowed extra keys for this event.

Loading content...

Required methods

pub fn record<M>(&self, extra: M) where
    M: Into<Option<HashMap<Self::Extra, String, RandomState>>>, [src]

Records an event.

Arguments

  • extra - A HashMap of (key, value) pairs. The key is one of the allowed extra keys as set in the metric defintion. If a wrong key is used or a value is larger than allowed, an error is reported and no event is recorded.

pub fn test_get_value<'a, S>(
    &self,
    ping_name: S
) -> Option<Vec<RecordedEvent, Global>> where
    S: Into<Option<&'a str>>, [src]

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.

pub fn test_get_num_recorded_errors<'a, S>(
    &self,
    error: ErrorType,
    ping_name: S
) -> i32 where
    S: Into<Option<&'a str>>, [src]

Exported for test purposes.

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

Arguments

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

Returns

The number of errors reported.

Loading content...

Implementors

impl<K: ExtraKeys> Event for EventMetric<K>[src]

type Extra = K

Loading content...