Enum routerify::Middleware [−][src]
pub enum Middleware<B, E> { Pre(PreMiddleware<E>), Post(PostMiddleware<B, E>), }
Expand description
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
.
- The
B
represents the response body type which will be used by route handlers and the middlewares and this body type must implement the HttpBody trait. For an instance,B
could be hyper::Body type. - The
E
represents any error type which will be used by route handlers and the middlewares. This error type must implement the std::error::Error.
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]
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]
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]
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]
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]
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]
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]
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
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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]