Struct gotham::middleware::state::StateMiddleware

pub struct StateMiddleware<T>where
    T: Clone + RefUnwindSafe + StateData + Sync,{ /* private fields */ }

Middleware binding for generic types to enable easy shared state.

This acts as nothing more than a Middleware instance which will attach a generic type to a request State, however it removes a barrier for users to Gotham who might not know the internals.

The generic types inside this struct can (and will) be cloned often, so wrap your expensive types in reference counts as needed.

Implementations

impl<T> StateMiddleware<T>where
    T: Clone + RefUnwindSafe + StateData + Sync,

Main implementation.

pub fn new(t: T) -> Self

Creates a new middleware binding, taking ownership of the state data.

Trait Implementations

impl<T: Clone> Clone for StateMiddleware<T>where
    T: Clone + RefUnwindSafe + StateData + Sync,

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> Middleware for StateMiddleware<T>where
    T: Clone + RefUnwindSafe + StateData + Sync,

Middleware trait implementation.

fn call<Chain>(self, state: State, chain: Chain) -> Pin<Box<HandlerFuture>>where
    Chain: FnOnce(State) -> Pin<Box<HandlerFuture>>,

Attaches the inner generic value to the request state.

This will enable the Handler to borrow the value directly from the state.

impl<T> NewMiddleware for StateMiddleware<T>where
    T: Clone + RefUnwindSafe + StateData + Sync,

NewMiddleware trait implementation.

fn new_middleware(&self) -> Result<Self::Instance>

Clones the current middleware to a new instance.

type Instance = StateMiddleware<T>

The type of Middleware created by the NewMiddleware.