Trait glean_core::traits::Numerator

source · 
pub trait Numerator {
    // Required methods
    fn add_to_numerator(&self, amount: i32);
    fn test_get_value<'a, S: Into<Option<&'a str>>>(
        &self,
        ping_name: S
    ) -> Option<Rate>;
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}
Expand description

A description for the NumeratorMetric subtype of the RateMetric type.

Required Methods§

source

fn add_to_numerator(&self, amount: i32)

Increases the numerator by amount.

§Arguments
  • amount - The amount to increase by. Should be non-negative.
§Notes

Logs an error if the amount is negative.

source

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

Exported for test purposes.

Gets the currently stored value as a pair of integers.

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

This doesn’t clear the stored value.

source

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.

Object Safety§

This trait is not object safe.

Implementors§