Skip to main content

MiddlewareStack

Struct MiddlewareStack 

Source
pub struct MiddlewareStack { /* private fields */ }
Expand description

An ordered list of middleware, outermost first.

What a route, a group, or a controller action attaches. The value that replaces Laravel’s $middlewareGroups entry.

Implementations§

Source§

impl MiddlewareStack

Source

pub fn new() -> Self

An empty stack.

Source

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

Append a middleware instance.

Source

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.

Source

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

Append every stage of other, keeping its order.

How a group nests inside a group.

Source

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.

Source

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.

Source

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.

Source

pub fn len(&self) -> usize

How many stages are declared.

Source

pub fn is_empty(&self) -> bool

Whether nothing is declared.

Source

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.

Source

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§

Source§

impl Clone for MiddlewareStack

Source§

fn clone(&self) -> MiddlewareStack

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MiddlewareStack

Source§

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

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

impl Default for MiddlewareStack

Source§

fn default() -> MiddlewareStack

Returns the “default value” for a type. Read more
Source§

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

Source§

fn from(middleware: M) -> Self

Converts to this type from the input type.
Source§

impl IntoMiddlewareStack for MiddlewareStack

Source§

fn into_middleware_stack(self) -> MiddlewareStack

Convert into a stack.

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more