WithMiddleware

Struct WithMiddleware 

Source
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 implements Endpoint
  • M - The middleware type that implements Middleware

§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>

Source

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 wrap
  • middleware - 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>

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl<E: Debug + Endpoint, M: Debug + Middleware> Debug for WithMiddleware<E, M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E: Default + Endpoint, M: Default + Middleware> Default for WithMiddleware<E, M>

Source§

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>

Source§

async fn respond(&mut self, request: &mut Request) -> Result<Response>

Processes an HTTP request and generates a response. Read more
Source§

impl<E: Hash + Endpoint, M: Hash + Middleware> Hash for WithMiddleware<E, M>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<E: Ord + Endpoint, M: Ord + Middleware> Ord for WithMiddleware<E, M>

Source§

fn cmp(&self, other: &WithMiddleware<E, M>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<E: PartialEq + Endpoint, M: PartialEq + Middleware> PartialEq for WithMiddleware<E, M>

Source§

fn eq(&self, other: &WithMiddleware<E, M>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<E: PartialOrd + Endpoint, M: PartialOrd + Middleware> PartialOrd for WithMiddleware<E, M>

Source§

fn partial_cmp(&self, other: &WithMiddleware<E, M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<E: Eq + Endpoint, M: Eq + Middleware> Eq for WithMiddleware<E, M>

Source§

impl<E: Endpoint, M: Middleware> StructuralPartialEq for WithMiddleware<E, M>

Auto Trait Implementations§

§

impl<E, M> Freeze for WithMiddleware<E, M>
where E: Freeze, M: Freeze,

§

impl<E, M> RefUnwindSafe for WithMiddleware<E, M>

§

impl<E, M> Send for WithMiddleware<E, M>

§

impl<E, M> Sync for WithMiddleware<E, M>

§

impl<E, M> Unpin for WithMiddleware<E, M>
where E: Unpin, M: Unpin,

§

impl<E, M> UnwindSafe for WithMiddleware<E, M>
where E: UnwindSafe, M: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.