Struct OnlyEvery

pub struct OnlyEvery { /* private fields */ }

A simple rate limiter which allows one element through on a given interval.

To use, call check and do whatever you want to do when it returns true.

The interval can be changed, and this will do what you expect as long as usage is only single-threaded. In multi-threaded programs, it is guaranteed that no execution can happen faster than the fastest interval passed to check, with behavior returning to normal once all threads are again passing the same value.

Implementations

impl OnlyEvery

pub fn new() -> OnlyEvery

pub fn check(&self, interval: Duration) -> bool

Check whether some code can execute, and record the time of the last successful check.

If this function returns true, the update has already been recorded as taking place.

interval is rounded up to the next ms.