Struct jsonrpsee_server::middleware::http::HostFilterLayer

pub struct HostFilterLayer(/* private fields */);

Middleware to enable host filtering.

Implementations

impl HostFilterLayer

pub fn new<T, U>(allow_only: T) -> Result<Self, AuthorityError>

where T: IntoIterator<Item = U>, U: TryInto<Authority, Error = AuthorityError>,

Enables host filtering and allow only the specified hosts.

pub fn disable() -> Self

Convenience method to disable host filtering but less efficient than to not enable the middleware at all.

Because is the tower middleware returns a different type depending on which Layers are configured it and may not compile in some contexts.

For example the following won’t compile:

use jsonrpsee_server::middleware::{ProxyGetRequestLayer, HostFilterLayer};

let host_filter = false;

let middleware = if host_filter {
    tower::ServiceBuilder::new()
       .layer(HostFilterLayer::new(["example.com"]).unwrap())
       .layer(ProxyGetRequestLayer::new("/health", "system_health").unwrap())
} else {
   tower::ServiceBuilder::new()
};

Trait Implementations

impl Clone for HostFilterLayer

fn clone(&self) -> HostFilterLayer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HostFilterLayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Layer<S> for HostFilterLayer

type Service = HostFilter<S>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.