Struct Throttle 

pub struct Throttle<T: Unsigned + AddAssign + Copy + PartialOrd> { /* private fields */ }

Implementations

impl<T: Unsigned + AddAssign + Copy + PartialOrd> Throttle<T>

pub fn new(max_per_period: T, period: Duration) -> Self

pub fn per_second(max_per_period: T) -> Self

Equivalent to

Throttle::new(max_per_period, Duration::from_secs(1))

pub fn per_minute(max_per_period: T) -> Self

Equivalent to

Throttle::new(max_per_period, Duration::from_secs(60))

pub async fn advance(&mut self) -> T

Advances the throttle by 1, waiting if the throttle has been exhausted

pub async fn advance_by(&mut self, by: T) -> T

Advances the throttle by the given amount, waiting if the throttle has been exhausted

pub async fn wait_if_exhausted(&self)

If throttle period has been exhausted, waits for the period to end
otherwise returns immediately

pub fn remaining(&self) -> T

Returns the remaining count for the current period

Trait Implementations

impl<T: Unsigned + AddAssign + Copy + PartialOrd> Clone for Throttle<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Unsigned + AddAssign + Copy + PartialOrd> Debug for Throttle<T>

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

Formats the value using the given formatter.