Struct RateLimit 

pub struct RateLimit { /* private fields */ }

Token-bucket rate limiter keyed by validated client IP.

State is process-local with a hard client bound. At saturation new identities are denied; existing depleted buckets are never evicted. Only fully replenished buckets expire, with bounded scanning per request. Proxy headers are ignored unless explicitly trusted. Unknown peers share one bucket; counters reset on process restart, so replicas multiply limits.

Implementations

impl RateLimit

pub fn new(burst: u32, per_second: f64) -> Self

Configure burst and refill; invalid values fail App validation.

Args: burst: Positive request-token capacity. per_second: Finite, positive replenishment rate.

Returns: Limiter; use Self::try_new to check configuration immediately.

pub fn try_new(burst: u32, rate: f64) -> Result<Self, RateLimitError>

Validate configuration before constructing a limiter.

Args: burst: Positive request-token capacity. rate: Finite, positive replenishment rate.

Returns: A valid limiter or a configuration error.

pub fn max_clients(self, max: usize) -> Self

Configure a hard client-state bound with fresh counters.

Args: max: Positive tracked-client capacity; zero is invalid.

Returns: A newly configured limiter; existing clones keep their counters.

pub fn trusted_proxies(self, proxies: TrustedProxies) -> Self

Trust forwarded client IP only from configured immediate peers.

Args: proxies: Policy requiring proxies to replace client headers.

Returns: Limiter using validated, normalized client IP addresses.

pub fn trust_forwarded_for(self, trust: bool) -> Self

Explicit compatibility trust for the first X-Forwarded-For hop.

Args: trust: Blanket ingress trust; false ignores forwarded client IP.

Returns: Limiter with the selected policy; malformed IPs are rejected.

Trait Implementations

impl Clone for RateLimit

fn clone(&self) -> RateLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimit

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

Formats the value using the given formatter.

impl Layer<BoxCloneSyncService<Request<Body>, Response<Body>, Infallible>> for RateLimit

type Service = BoxCloneSyncService<Request<Body>, Response<Body>, Infallible>

The wrapped service

fn layer(&self, inner: BoxService) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.