Struct throttle_timer::ThrottleTimer

pub struct ThrottleTimer { /* fields omitted */ }

Methods

impl ThrottleTimer

Example

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

let mut break_timer: ThrottleTimer = ThrottleTimer::new(Duration::from_secs(1_u64), &"Break");
let do_break_flag = break_timer.run(&mut || {});

// Timers always run when no previous runs
assert!(do_break_flag == true);
if do_break_flag {
    println!("timer do run flag is set to true")
}

// Run flag false as no time has passed
assert!(break_timer.run(&mut || {}) == false);

pub fn new(max_frequency: Duration, event_name: &'static str) -> Self

pub const fn event_name(&self) -> &str

pub const fn total_calls(&self) -> &usize

pub const fn max_frequency(&self) -> &Duration

pub const fn created_date(&self) -> SystemTime

pub fn wait_time(&self) -> Duration

pub fn print_stats(&self)

Prints total calls and calls/sec

pub fn can_run(&mut self) -> bool

Calling run() will check the last call time. If max frequency time has not passed the fn will return false. If max_frequency duration has passed since the last call then the fn will return true

pub fn run_throttle_cb(
    &mut self,
    success: &mut dyn FnMut(),
    throttled: &mut dyn FnMut()
) -> bool

pub fn run(&mut self, success: &mut dyn FnMut()) -> bool

Calling run() will check the last call time. If max frequency time has not passed the fn will return false. If max_frequency duration has passed since the last call then the fn will return true

pub fn run_wait(&mut self, success: &mut dyn FnMut())

Calling run() will check the last call time. If max frequency time has not passed the fn will return false. If max_frequency duration has passed since the last call then the fn will return true

pub fn run_with_msg(&mut self, success: &mut dyn FnMut()) -> bool

Trait Implementations

impl Debug for ThrottleTimer

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.