Struct RateLimiterBuilder

pub struct RateLimiterBuilder<BE, BO, F> { /* private fields */ }

Implementations

impl<BE, BI, BO, F, O> RateLimiterBuilder<BE, BO, F>

where BE: Backend<BI, Output = BO> + 'static, BI: 'static, F: Fn(&ServiceRequest) -> O, O: Future<Output = Result<BI, Error>>,

pub fn fail_open(self, fail_open: bool) -> Self

Choose whether to allow a request if the backend returns a failure.

Default is false.

pub fn add_headers(self) -> Self

where BO: HeaderCompatibleOutput,

Sets the RateLimiterBuilder::request_allowed_transformation and RateLimiterBuilder::request_denied_response functions, such that the following headers are set in both the allowed and denied responses:

• x-ratelimit-limit\
• x-ratelimit-remaining\
• x-ratelimit-reset (seconds until the reset)
• retry-after (denied only, seconds until the reset)

This function requires the Backend Output to implement HeaderCompatibleOutput

pub fn request_allowed_transformation<M>(self, mutation: Option<M>) -> Self

where M: Fn(&mut HeaderMap, Option<&BO>, bool) + 'static,

In the event that the request is allowed:

You can optionally mutate the response headers to include the rate limit status.

By default no changes are made to the response.

Note the Backend::Output will be None if the backend failed and RateLimiterBuilder::fail_open is enabled.

The boolean parameter indicates if the rate limit was rolled back (so the remaining request count can be adjusted).

pub fn request_denied_response<R>(self, denied_response: R) -> Self

where R: Fn(&BO) -> HttpResponse + 'static,

In the event that the request is denied, configure the HttpResponse returned.

Defaults to an empty body with status 429.

pub fn rollback_condition<C>(self, condition: Option<C>) -> Self

where C: Fn(StatusCode) -> bool + 'static,

After processing a request, attempt to rollback the request count based on the status of the service response.

By default the rate limit is never rolled back.

pub fn rollback_server_errors(self) -> Self

Configures the RateLimiterBuilder::rollback_condition to rollback if the status code is a server error (5xx).

pub fn build(self) -> RateLimiter<BE, BO, F>