Struct MiddlewareStack 

pub struct MiddlewareStack { /* private fields */ }

An ordered list of middleware, outermost first.

What a route, a group, or a controller action attaches. The value that replaces a name-keyed group entry.

Implementations

impl MiddlewareStack

pub fn new() -> Self

An empty stack.

pub fn with(self, middleware: impl Middleware) -> Self

Append a middleware instance.

pub fn with_arc(self, middleware: Arc<dyn Middleware>) -> Self

Append an already-shared instance.

For middleware built once and attached to several routes — a rate limiter, whose counters are the point of sharing it.

pub fn with_stack(self, other: MiddlewareStack) -> Self

Append every stage of other, keeping its order.

How a group nests inside a group.

pub fn deferred<M, F>(self, build: F) -> Self

where M: Middleware, F: Fn(&Container) -> Result<M> + Send + Sync + 'static,

Append middleware built when the router compiles, from the container.

For anything that cannot exist while routes are being declared: the container is populated by then, and the first request has not arrived. See the module docs.

pub fn resolved<S, M, F>(self, build: F) -> Self

where S: Send + Sync + 'static, M: Middleware, F: Fn(Arc<S>) -> M + Send + Sync + 'static,

Append middleware built from one service in the container.

The common shape of deferred, with the resolve spelled once:

MiddlewareStack::new()
    .resolved(|auth: Arc<AuthManager<User>>| Authenticate::new(auth))

A missing binding fails the boot with the service’s type name in the message, which is the container’s own error.

pub fn prepend(&mut self, outer: &MiddlewareStack)

Prepend every stage of outer, so it runs first.

How a group’s middleware ends up outside a route’s own.

pub fn len(&self) -> usize

How many stages are declared.

pub fn is_empty(&self) -> bool

Whether nothing is declared.

pub fn resolve(&self, container: &Container) -> Result<Vec<Arc<dyn Middleware>>>

Build every stage, running the deferred closures against container.

Called once, when the router compiles.

pub fn labels(&self) -> Vec<&'static str>

The label of each stage, for diagnostics before resolution.

A deferred stage reports its declared type, which is the best that can be said before it is built.

Trait Implementations

impl Clone for MiddlewareStack

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MiddlewareStack

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

Formats the value using the given formatter.

impl Default for MiddlewareStack

fn default() -> Self

Returns the “default value” for a type.

impl<M: Middleware> From<M> for MiddlewareStack

fn from(middleware: M) -> Self

Converts to this type from the input type.

impl IntoMiddlewareStack for MiddlewareStack

fn into_middleware_stack(self) -> MiddlewareStack

Convert into a stack.