Struct Rate

pub struct Rate { /* private fields */ }

A stable rate estimator that reports the rate of events in the past interval time. It returns the average rate between interval * 2 and interval while collecting the events happening between interval and now.

This estimator ignores events that happen less than once per interval time.

Implementations

impl Rate

pub fn new(interval: Duration) -> Rate

Create a new Rate with the given interval.

pub fn new_with_estimator_config( interval: Duration, hashes: usize, slots: usize, ) -> Rate

Create a new Rate with the given interval and Estimator config with the given amount of hashes and columns (slots).

pub fn rate<T>(&self, key: &T) -> f64

where T: Hash,

Return the per second rate estimation.

pub fn observe<T>(&self, key: &T, events: isize) -> isize

where T: Hash,

Report new events and return number of events seen so far in the current interval.

pub fn rate_with<F, T, K>(&self, key: &K, rate_calc_fn: F) -> T

where F: FnMut(RateComponents) -> T, K: Hash,

Get the current rate as calculated with the given closure. This closure will take an argument containing all the accessible information about the rate from this object and allow the caller to make their own estimation of rate based on:

1. The accumulated samples in the current interval (in progress)
2. The accumulated samples in the previous interval (completed)
3. The size of the interval
4. Elapsed fraction of current interval for this sample (0..1)