Struct RatePolicy 

pub struct RatePolicy { /* private fields */ }

A Policy that limits the rate of inputs: one unit is spent from a shared token bucket per input.

Two modes:

• RatePolicy::abort: an input beyond the budget is aborted with RateLimitReached — the classic rate-limit path (e.g. mapped to 429 Too Many Requests, using the carried retry_after).
• RatePolicy::wait: an input beyond the budget waits until the bucket allows it — natural pacing, no error path.

Cloning shares the underlying RateLimiter (same budget), just like cloning a ConcurrentPolicy shares its tracker. To share one budget across differently-configured policies or stacks, construct a RateLimiter yourself and use RatePolicy::abort_with_limiter / RatePolicy::wait_with_limiter.

To combine “at most N in flight” with “at most M per second”, stack two limit layers, with the rate limit outside the concurrency limit (cheap rejection first, no concurrency slot consumed).

Implementations

impl RatePolicy

pub fn wait(rate: Rate) -> RatePolicy

Create a new RatePolicy that paces inputs beyond the given Rate: they wait, they never fail.

pub fn abort(rate: Rate) -> RatePolicy

Create a new RatePolicy that aborts inputs beyond the given Rate with RateLimitReached.

pub fn wait_with_limiter(limiter: RateLimiter) -> RatePolicy

Like RatePolicy::wait, with a caller-provided (shareable) RateLimiter.

pub fn abort_with_limiter(limiter: RateLimiter) -> RatePolicy

Like RatePolicy::abort, with a caller-provided (shareable) RateLimiter.

pub fn with_burst(self, burst: u64) -> RatePolicy

Override the burst capacity (default: one period worth of units).

This rebuilds the policy’s own RateLimiter: any previously shared budget handle is disconnected.

pub fn set_burst(&mut self, burst: u64) -> &mut RatePolicy

Override the burst capacity (default: one period worth of units).

This rebuilds the policy’s own RateLimiter: any previously shared budget handle is disconnected.

pub fn limiter(&self) -> &RateLimiter

The RateLimiter enforcing this policy’s budget (clone it to share the budget elsewhere).

Trait Implementations

impl Clone for RatePolicy

fn clone(&self) -> RatePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RatePolicy

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

Formats the value using the given formatter.

impl<Input> Policy<Input> for RatePolicy

where Input: Send + 'static,

type Guard = ()

The guard type that is returned when the input is allowed to proceed.

type Error = RateLimitReached

The error type that is returned when the input is not allowed to proceed, and should be aborted.

async fn check( &self, input: Input, ) -> PolicyResult<Input, <RatePolicy as Policy<Input>>::Guard, <RatePolicy as Policy<Input>>::Error>

Check whether the input is allowed to proceed.