Struct ProbRateLimiter 

pub struct ProbRateLimiter { /* private fields */ }

A probabilistic rate-limiter.

• When not overloaded, accepts all requests
• As load approaches limit, probabilistically rejects more and more requests.
• Onset of overload does not trigger a sudden total outage.

Implementations

impl ProbRateLimiter

pub fn new_custom( tick_duration: Duration, max_cost_per_tick: u32, now: Instant, prng: Rand32, ) -> Result<Self, String>

Makes a new rate limiter that accepts max_cost_per_tick every tick_duration.

Errors

Returns an error when tick_duration is less than 1 microsecond.

pub fn new(max_cost_per_sec: u32) -> Self

Makes a new rate limiter that accepts max_cost_per_sec cost every second.

pub fn attempt(&mut self, now: Instant) -> bool

Try a request. Returns true when the request should be accepted.

pub fn record(&mut self, cost: u32)

Record the cost of a request.

pub fn check(&mut self, cost: u32, now: Instant) -> bool

A convenience method that calls [attempt] and [record]. Use this when the cost of each request is fixed or cheap to calculate.

Trait Implementations

impl Clone for ProbRateLimiter

fn clone(&self) -> ProbRateLimiter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProbRateLimiter

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

Formats the value using the given formatter.