Struct actix_ip_filter::IPFilter

pub struct IPFilter { /* fields omitted */ }

Middleware for filter IP of HTTP requests

Implementations

impl IPFilter

pub fn new() -> Self

Construct IPFilter middleware with no arguments

pub fn new_with_opts(
    allowlist: Vec<&str>,
    blocklist: Vec<&str>,
    use_x_real_ip: bool
) -> Self

Construct IPFilter middleware with the provided arguments

pub fn x_real_ip(self, enabled: bool) -> Self

Use X-REAL-IP header to check IP if it is found in request.

pub fn allow(self, allowlist: Vec<&str>) -> Self

Set allow IP list, it supported glob pattern. It will allow all if vec is empty.

Example

let middleware = IPFilter::new()
    .allow(vec!["127.??.6*.12", "!1.2.*.4'"]);

pub fn block(self, blocklist: Vec<&str>) -> Self

Set block IP list, it supported glob pattern.

Example

let middleware = IPFilter::new()
    .block(vec!["127.??.6*.12", "!1.2.*.4'"]);

Trait Implementations

impl<S, B> Transform<S> for IPFilter where
    S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error>,
    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 transform service.

type Transform = IPFilterMiddleware<S>

The TransformService value created by this factory

type Future = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

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

Creates and returns a new Transform component, asynchronously

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

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