Trait glean_core::traits::Rate

source · 
pub trait Rate: TestGetValue<Output = Rate> {
    // Required methods
    fn add_to_numerator(&self, amount: i32);
    fn add_to_denominator(&self, amount: i32);
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}
Expand description

A description for 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 add_to_denominator(&self, amount: i32)

Increases the denominator 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_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§