Struct RateLimitFilter 

pub struct RateLimitFilter { /* private fields */ }

Token bucket rate limiter that rejects excess traffic with 429.

Supports global (one shared bucket) and per_ip (one bucket per source IP) modes. Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are injected into both 429 rejections and successful responses.

State is all managed locally.

YAML configuration

filter: rate_limit
mode: per_ip        # "per_ip" or "global"
rate: 100           # tokens per second
burst: 200          # max bucket capacity

Example

use praxis_filter::RateLimitFilter;

let yaml: serde_yaml::Value = serde_yaml::from_str(
    r#"
mode: global
rate: 50
burst: 100
"#,
)
.unwrap();
let filter = RateLimitFilter::from_config(&yaml).unwrap();
assert_eq!(filter.name(), "rate_limit");

Implementations

impl RateLimitFilter

pub fn from_config(config: &Value) -> Result<Box<dyn HttpFilter>, FilterError>

Create a rate limit filter from parsed YAML config.

Errors

Returns an error if any field is missing, rate is not positive, burst is zero, or burst < rate.

Example

use praxis_filter::RateLimitFilter;

let yaml: serde_yaml::Value = serde_yaml::from_str(
    r#"
mode: per_ip
rate: 100
burst: 200
"#,
)
.unwrap();
let filter = RateLimitFilter::from_config(&yaml).unwrap();
assert_eq!(filter.name(), "rate_limit");

// Invalid: rate is zero.
let bad: serde_yaml::Value = serde_yaml::from_str("mode: global\nrate: 0\nburst: 10").unwrap();
assert!(RateLimitFilter::from_config(&bad).is_err());

Trait Implementations

impl HttpFilter for RateLimitFilter

fn name(&self) -> &'static str

Unique name identifying this filter type (e.g. "router", "rate_limit").

fn on_request<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each incoming request, in pipeline order.

fn on_response<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Called for each response, in reverse pipeline order.

fn request_body_access(&self) -> BodyAccess

Declares what access this filter needs to request bodies.

fn response_body_access(&self) -> BodyAccess

Declares what access this filter needs to response bodies.

fn request_body_mode(&self) -> BodyMode

Declares the delivery mode for request body chunks.

fn response_body_mode(&self) -> BodyMode

Declares the delivery mode for response body chunks.

fn needs_request_context(&self) -> bool

Whether this filter needs the original request context during body phases.

fn apply_insecure_options(&self, _options: &InsecureOptions)

Apply global InsecureOptions to this filter.

fn compression_config(&self) -> Option<&CompressionConfig>

Returns the compression configuration if this filter enables response compression.

fn on_request_body<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, ctx: &'life1 mut HttpFilterContext<'life2>, body: &'life3 mut Option<Bytes>, end_of_stream: bool, ) -> Pin<Box<dyn Future<Output = Result<FilterAction, FilterError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Called for each chunk of request body data, in pipeline order.

fn on_response_body( &self, ctx: &mut HttpFilterContext<'_>, body: &mut Option<Bytes>, end_of_stream: bool, ) -> Result<FilterAction, FilterError>

Called for each chunk of response body data, in reverse pipeline order.