Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

Token-bucket rate-limit throttle.

Implementations

impl TokenBucket

pub fn new(rate_bytes_per_sec: u64) -> Self

Construct a new throttle at rate_bytes_per_sec. The throttle’s clock starts at construction time.

pub fn next_sleep(&self, bytes_done: u64) -> Duration

Inspect whether the loop is currently over-budget and, if so, return the recommended sleep duration to converge to the rate. Returns Duration::ZERO when the throttle is happy with current progress.

pub fn maybe_sleep(&self, bytes_done: u64) -> bool

Sleep for the recommended interval if any. Returns true if a sleep was performed, false if no sleep was needed.

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenBucket

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

Formats the value using the given formatter.