#throttle #timer

throttle-timer

Throttle events and record event stats with a simple library

6 releases (1 stable)

✓ Uses Rust 2018 edition

1.0.0 Nov 8, 2019
0.0.6 Nov 7, 2019

#15 in #timer

Apache-2.0 OR MIT

12KB
183 lines

Rust throttle_timer

Simple Rust library to throttle events and record event stats

Docs Build Status Coverage Status Current Crates.io Version License

Install Cargo.toml

throttle-timer = "1.0.0"

Example use

use std::time::Duration;
use throttle_timer::ThrottleTimer;

let mut throttled_fn = ThrottleTimer::new(Duration::from_secs(10_u64), &"throttled_fn");
let mut val = 0_u8;

// timers always run when no previous runs
throttled_fn.run(&mut || val += 1);
for _ in 0..100 {
    // timer will not run as 10 secs has not passed
    // do run will return false
    throttled_fn.run(&mut || val += 1);
}

throttled_fn.print_stats();
// throttled_fn called 0/sec, total calls 1, has been running for 10us

assert_eq!(throttled_fn.total_calls(), &1);
assert_eq!(val, 1_u8);

No runtime deps