Enum routerify::Middleware[−][src]

pub enum Middleware<B, E> {
    Pre(PreMiddleware<E>),
    Post(PostMiddleware<B, E>),
}

Enum type for all the middleware types. Please refer to the Middleware for more info.

This Middleware<B, E> type accepts two type parameters: B and E.

Variants

Pre(PreMiddleware<E>)

Variant for the pre middleware. Refer to Pre Middleware for more info.

Post(PostMiddleware<B, E>)

Variant for the post middleware. Refer to Post Middleware for more info.

Implementations

impl<B: HttpBody + Send + Sync + 'static, E: Into<Box<dyn Error + Send + Sync>> + 'static> Middleware<B, E>[src]

pub fn pre<H, R>(handler: H) -> Middleware<B, E> where
    H: Fn(Request<Body>) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Request<Body>, E>> + Send + 'static, [src]

Creates a pre middleware with a handler at the /* path.

Examples

use routerify::{Router, Middleware};
use hyper::{Request, Body};
use std::convert::Infallible;

let router = Router::builder()
     .middleware(Middleware::pre(|req| async move { /* Do some operations */ Ok(req) }))
     .build()
     .unwrap();

pub fn post<H, R>(handler: H) -> Middleware<B, E> where
    H: Fn(Response<B>) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Response<B>, E>> + Send + 'static, [src]

Creates a post middleware with a handler at the /* path.

Examples

use routerify::{Router, Middleware};
use hyper::{Response, Body};
use std::convert::Infallible;

let router = Router::builder()
     .middleware(Middleware::post(|res| async move { /* Do some operations */ Ok(res) }))
     .build()
     .unwrap();

pub fn post_with_info<H, R>(handler: H) -> Middleware<B, E> where
    H: Fn(Response<B>, RequestInfo) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Response<B>, E>> + Send + 'static, [src]

Creates a post middleware which can access request info e.g. headers, method, uri etc. It should be used when the post middleware trandforms the response based on the request information.

Examples

use routerify::{Router, Middleware, PostMiddleware, RequestInfo};
use hyper::{Response, Body};
use std::convert::Infallible;

async fn post_middleware_with_info_handler(res: Response<Body>, req_info: RequestInfo) -> Result<Response<Body>, Infallible> {
    let headers = req_info.headers();
     
    // Do some response transformation based on the request headers, method etc.
     
    Ok(res)
}

let router = Router::builder()
     .middleware(Middleware::post_with_info(post_middleware_with_info_handler))
     .build()
     .unwrap();

pub fn pre_with_path<P, H, R>(path: P, handler: H) -> Result<Middleware<B, E>> where
    P: Into<String>,
    H: Fn(Request<Body>) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Request<Body>, E>> + Send + 'static, [src]

Create a pre middleware with a handler at the specified path.

Examples

use routerify::{Router, Middleware};
use hyper::{Request, Body};
use std::convert::Infallible;

let router = Router::builder()
     .middleware(Middleware::pre_with_path("/my-path", |req| async move { /* Do some operations */ Ok(req) }).unwrap())
     .build()
     .unwrap();

pub fn post_with_path<P, H, R>(path: P, handler: H) -> Result<Middleware<B, E>> where
    P: Into<String>,
    H: Fn(Response<B>) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Response<B>, E>> + Send + 'static, [src]

Creates a post middleware with a handler at the specified path.

Examples

use routerify::{Router, Middleware};
use hyper::{Response, Body};
use std::convert::Infallible;

let router = Router::builder()
     .middleware(Middleware::post_with_path("/my-path", |res| async move { /* Do some operations */ Ok(res) }).unwrap())
     .build()
     .unwrap();

pub fn post_with_info_with_path<P, H, R>(
    path: P,
    handler: H
) -> Result<Middleware<B, E>> where
    P: Into<String>,
    H: Fn(Response<B>, RequestInfo) -> R + Send + Sync + 'static,
    R: Future<Output = Result<Response<B>, E>> + Send + 'static, [src]

Creates a post middleware which can access request info e.g. headers, method, uri etc. It should be used when the post middleware trandforms the response based on the request information.

Examples

use routerify::{Router, Middleware, PostMiddleware, RequestInfo};
use hyper::{Response, Body};
use std::convert::Infallible;

async fn post_middleware_with_info_handler(res: Response<Body>, req_info: RequestInfo) -> Result<Response<Body>, Infallible> {
    let _headers = req_info.headers();
     
    // Do some response transformation based on the request headers, method etc.
     
    Ok(res)
}

let router = Router::builder()
     .middleware(Middleware::post_with_info_with_path("/abc", post_middleware_with_info_handler).unwrap())
     .build()
     .unwrap();

Trait Implementations

impl<B: Debug, E: Debug> Debug for Middleware<B, E>[src]

Auto Trait Implementations

impl<B, E> !RefUnwindSafe for Middleware<B, E>

impl<B, E> Send for Middleware<B, E>

impl<B, E> Sync for Middleware<B, E>

impl<B, E> Unpin for Middleware<B, E>

impl<B, E> !UnwindSafe for Middleware<B, E>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> Pointable for T[src]

type Init = T

The type for initializers.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.