pub struct WithMiddleware<E: Endpoint, M: Middleware> { /* private fields */ }Expand description
A wrapper that combines an endpoint with middleware.
WithMiddleware allows you to compose an endpoint with middleware to add
cross-cutting concerns like logging, authentication, rate limiting, etc.
The middleware is executed first and can decide whether to call the endpoint
and how to process the response.
§Type Parameters
E- The endpoint type that implementsEndpointM- The middleware type that implementsMiddleware
§Examples
use http_kit::{Request, Response, Result, Endpoint, Middleware, endpoint::WithMiddleware};
struct TimingMiddleware;
impl Middleware for TimingMiddleware {
async fn handle(&self, request: &mut Request, next: impl Endpoint) -> Result<Response> {
let start = std::time::Instant::now();
let response = next.respond(request).await;
let duration = start.elapsed();
println!("Request took {:?}", duration);
response
}
}
struct HelloEndpoint;
impl Endpoint for HelloEndpoint {
async fn respond(&self, _request: &mut Request) -> Result<Response> {
Ok(Response::new(200, "Hello"))
}
}
let timed_endpoint = WithMiddleware::new(HelloEndpoint, TimingMiddleware);Implementations§
Source§impl<E: Endpoint, M: Middleware> WithMiddleware<E, M>
impl<E: Endpoint, M: Middleware> WithMiddleware<E, M>
Sourcepub fn new(endpoint: E, middleware: M) -> Self
pub fn new(endpoint: E, middleware: M) -> Self
Creates a new endpoint that wraps the given endpoint with middleware.
When the resulting endpoint handles a request, the middleware will be executed first. The middleware can then decide whether to call the wrapped endpoint and how to process its response.
§Arguments
endpoint- The endpoint to wrapmiddleware- The middleware to apply
§Examples
use http_kit::{Request, Response, Result, Endpoint, Middleware, endpoint::WithMiddleware};
struct AuthMiddleware { token: String }
impl Middleware for AuthMiddleware {
async fn handle(&self, request: &mut Request, next: impl Endpoint) -> Result<Response> {
if let Some(auth) = request.get_header(http::header::AUTHORIZATION) {
if auth.as_bytes() == self.token.as_bytes() {
return next.respond(request).await;
}
}
Ok(Response::new(401, "Unauthorized"))
}
}
struct SecretEndpoint;
impl Endpoint for SecretEndpoint {
async fn respond(&self, _request: &mut Request) -> Result<Response> {
Ok(Response::new(200, "Secret data"))
}
}
let auth_middleware = AuthMiddleware { token: "secret".to_string() };
let protected_endpoint = WithMiddleware::new(SecretEndpoint, auth_middleware);Trait Implementations§
Source§impl<E: Clone + Endpoint, M: Clone + Middleware> Clone for WithMiddleware<E, M>
impl<E: Clone + Endpoint, M: Clone + Middleware> Clone for WithMiddleware<E, M>
Source§fn clone(&self) -> WithMiddleware<E, M>
fn clone(&self) -> WithMiddleware<E, M>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<E: Debug + Endpoint, M: Debug + Middleware> Debug for WithMiddleware<E, M>
impl<E: Debug + Endpoint, M: Debug + Middleware> Debug for WithMiddleware<E, M>
Source§impl<E: Default + Endpoint, M: Default + Middleware> Default for WithMiddleware<E, M>
impl<E: Default + Endpoint, M: Default + Middleware> Default for WithMiddleware<E, M>
Source§fn default() -> WithMiddleware<E, M>
fn default() -> WithMiddleware<E, M>
Returns the “default value” for a type. Read more
Source§impl<E: Endpoint, M: Middleware> Endpoint for WithMiddleware<E, M>
impl<E: Endpoint, M: Middleware> Endpoint for WithMiddleware<E, M>
Source§impl<E: Hash + Endpoint, M: Hash + Middleware> Hash for WithMiddleware<E, M>
impl<E: Hash + Endpoint, M: Hash + Middleware> Hash for WithMiddleware<E, M>
Source§impl<E: Ord + Endpoint, M: Ord + Middleware> Ord for WithMiddleware<E, M>
impl<E: Ord + Endpoint, M: Ord + Middleware> Ord for WithMiddleware<E, M>
Source§fn cmp(&self, other: &WithMiddleware<E, M>) -> Ordering
fn cmp(&self, other: &WithMiddleware<E, M>) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
Source§impl<E: PartialEq + Endpoint, M: PartialEq + Middleware> PartialEq for WithMiddleware<E, M>
impl<E: PartialEq + Endpoint, M: PartialEq + Middleware> PartialEq for WithMiddleware<E, M>
Source§impl<E: PartialOrd + Endpoint, M: PartialOrd + Middleware> PartialOrd for WithMiddleware<E, M>
impl<E: PartialOrd + Endpoint, M: PartialOrd + Middleware> PartialOrd for WithMiddleware<E, M>
impl<E: Eq + Endpoint, M: Eq + Middleware> Eq for WithMiddleware<E, M>
impl<E: Endpoint, M: Middleware> StructuralPartialEq for WithMiddleware<E, M>
Auto Trait Implementations§
impl<E, M> Freeze for WithMiddleware<E, M>
impl<E, M> RefUnwindSafe for WithMiddleware<E, M>where
E: RefUnwindSafe,
M: RefUnwindSafe,
impl<E, M> Send for WithMiddleware<E, M>
impl<E, M> Sync for WithMiddleware<E, M>
impl<E, M> Unpin for WithMiddleware<E, M>
impl<E, M> UnwindSafe for WithMiddleware<E, M>where
E: UnwindSafe,
M: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more