Struct FilterLayer 

pub struct FilterLayer<H, R, T> { /* private fields */ }

Available on crate feature server only.

Layer for filtering requests

See FilterLayer::new for more details.

Implementations

impl<H, R, T> FilterLayer<H, R, T>

pub fn new(h: H) -> Self

Create a new FilterLayer

The handler is an async function with some params that implement FromContext, and returns Result<(), impl IntoResponse>.

If the handler returns Ok(()), the request will proceed. However, if the handler returns Err with an object that implements IntoResponse, the request will be rejected with the returned object as the response.

Examples

use http::{method::Method, status::StatusCode};
use volo_http::server::{
    layer::FilterLayer,
    route::{Router, get},
};

async fn reject_post(method: Method) -> Result<(), StatusCode> {
    if method == Method::POST {
        Err(StatusCode::METHOD_NOT_ALLOWED)
    } else {
        Ok(())
    }
}

async fn handler() -> &'static str {
    "Hello, World"
}

let router: Router = Router::new()
    .route("/", get(handler))
    .layer(FilterLayer::new(reject_post));

Trait Implementations

impl<H: Clone, R: Clone, T: Clone> Clone for FilterLayer<H, R, T>

fn clone(&self) -> FilterLayer<H, R, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, H, R, T> Layer<S> for FilterLayer<H, R, T>

where S: Send + Sync + 'static, H: Clone + Send + Sync + 'static, T: Sync,

type Service = Filter<S, H, R, T>

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. Consumes self.