Struct limitation_actix_middleware::RateLimiter

pub struct RateLimiter;

Middleware for rate limiting requests using a fixed window counter keyed on a HeaaderName.

Example

A basic example:

use actix_web::{http::header::HeaderName, web, App, HttpResponse};
use limitation_actix_middleware::{Limiter, RateLimiter};

let header = web::Data::new(HeaderName::from_static("authorization"));
let limiter = web::Data::new(Limiter::build("redis://127.0.0.1/").finish()?);

let app = App::new()
    .register_data(header.clone())
    .register_data(limiter.clone())
    .wrap(RateLimiter)
    .service(
        web::resource("/test")
            .route(web::get().to(|| HttpResponse::Ok()))
            .route(web::head().to(|| HttpResponse::MethodNotAllowed()))
    );

Trait Implementations

impl<S, B> Transform<S> for RateLimiter where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
    S::Future: 'static,
    B: 'static, 

type Request = ServiceRequest

Requests handled by the service.

type Response = ServiceResponse<B>

Responses given by the service.

type Error = Error

Errors produced by the service.

type InitError = ()

Errors produced while building a service.

type Transform = RateLimiterMiddleware<S>

The TransformService value created by this factory

type Future = FutureResult<Self::Transform, Self::InitError>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Service component, asynchronously

fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
    F: Fn(Self::InitError) -> E, 

Map this service's factory error to a different error, returning a new transform service factory.

fn from_err<E>(self) -> TransformFromErr<Self, S, E> where
    E: From<Self::InitError>, 

Map this service's init error to any error implementing From for this services Error`.