Struct under::middleware::StateMiddleware

pub struct StateMiddleware<T>(_);

The middleware for inserting state into a request.

This inserts the inner state value into the request every time the middleware is run, before passing on the request down stream. You can append as many state middlewares as you like, as long as the inner type T does not overlap (otherwise, the last value would win).

This type requires the inner type to be Clone, as it must be cloned on every request. It is recommended to wrap the type in a reference-counting type, like std::sync::Arc, if it is not already in one.

Implementations

impl<T> StateMiddleware<T>

pub fn new(value: T) -> Self

Creates an instance of the state middleware with the given value.

Examples

under::http()
    .with(under::middleware::StateMiddleware::new(123u32));

Trait Implementations

impl<T: Clone> Clone for StateMiddleware<T>

fn clone(&self) -> StateMiddleware<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StateMiddleware<T>

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

Formats the value using the given formatter.

impl<T: Clone + Send + Sync + 'static> Middleware for StateMiddleware<T>

fn apply<'life0, 'life1, 'async_trait>(
    self: Pin<&'life0 Self>,
    request: Request,
    next: Next<'life1>
) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Handles the given request, returning a response. The next parameter contains the information on how to process everything after the current middleware, i.e. generating a response from the endpoint.