Struct RateLimitBuilder 

pub struct RateLimitBuilder { /* private fields */ }

Builder for configuring a RateLimitMiddleware.

Implementations

impl RateLimitBuilder

pub fn new() -> Self

Create a new builder.

pub fn route<F>(self, configure: F) -> Self

where F: FnOnce(RouteBuilder) -> RouteBuilder,

Add a route using a closure-based configuration.

Panics

Panics if no limits are configured via .limit().

Example

use route_ratelimit::RateLimitMiddleware;
use std::time::Duration;

let middleware = RateLimitMiddleware::builder()
    .route(|r| r.limit(15000, Duration::from_secs(10)))
    .route(|r| r.path("/api").limit(1000, Duration::from_secs(10)))
    .build();

pub fn host<F>(self, host: impl Into<String>, configure: F) -> Self

where F: FnOnce(HostBuilder) -> HostBuilder,

Configure routes for a specific host using a scoped builder.

This is the preferred way to configure multiple routes for the same host, as it avoids repeating the host for each route.

Example

use route_ratelimit::{RateLimitMiddleware, ThrottleBehavior};
use std::time::Duration;
use http::Method;

let middleware = RateLimitMiddleware::builder()
    .host("clob.polymarket.com", |host| {
        host
            .route(|r| r.limit(9000, Duration::from_secs(10)))
            .route(|r| r.path("/book").limit(1500, Duration::from_secs(10)))
            .route(|r| r.path("/price").limit(1500, Duration::from_secs(10)))
            .route(|r| {
                r.method(Method::POST)
                    .path("/order")
                    .limit(3500, Duration::from_secs(10))
                    .limit(36000, Duration::from_secs(600))
            })
    })
    .host("data-api.polymarket.com", |host| {
        host
            .route(|r| r.limit(1000, Duration::from_secs(10)))
            .route(|r| r.path("/trades").limit(200, Duration::from_secs(10)))
    })
    .build();

pub fn add_route(self, route: Route) -> Self

Add a pre-configured route.

pub fn build(self) -> RateLimitMiddleware

Build the middleware.

Warnings

If the tracing feature is enabled, this method will emit a warning when catch-all routes (routes with no host, method, or path filters) are followed by more specific routes. This pattern may cause unexpected behavior since all matching routes’ limits are applied.

Trait Implementations

impl Clone for RateLimitBuilder

fn clone(&self) -> RateLimitBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitBuilder

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

Formats the value using the given formatter.

impl Default for RateLimitBuilder

fn default() -> RateLimitBuilder

Returns the “default value” for a type.