Struct IpFilter 

pub struct IpFilter { /* private fields */ }

Middleware that filters requests by client IP address.

Constructed via IpFilter::allow or IpFilter::deny. Each entry may be an exact address ("1.2.3.4", "2001:db8::1") or a CIDR range ("10.0.0.0/8", "2001:db8::/32"). Malformed entries are skipped; check them with is_valid_entry (rws --check does).

Implementations

impl IpFilter

pub fn allow(entries: impl IntoIterator<Item = impl AsRef<str>>) -> IpFilter

Create an allowlist filter. Only IPs matching one of entries pass; all others receive 403 Forbidden.

Example

use rust_web_server::ip_filter::IpFilter;

let filter = IpFilter::allow(["127.0.0.1", "10.0.0.0/8"]);

pub fn deny(entries: impl IntoIterator<Item = impl AsRef<str>>) -> IpFilter

Create a denylist filter. IPs matching one of entries receive 403 Forbidden; all others pass.

Example

use rust_web_server::ip_filter::IpFilter;

let filter = IpFilter::deny(["1.2.3.4", "192.0.2.0/24"]);

Trait Implementations

impl Middleware for IpFilter

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

Headers only: a streamed body passes through untouched.

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

In-memory only: safe on the event loop.

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

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

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.