GroupDef

Struct GroupDef 

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

Group definition that collects routes and applies prefix/middleware

Supports nested groups for arbitrary route organization:

routes! {
    group!("/api", {
        get!("/users", controllers::user::index).name("api.users"),
        post!("/users", controllers::user::store),
        // Nested groups are supported
        group!("/admin", {
            get!("/dashboard", controllers::admin::dashboard),
        }),
    }).middleware(AuthMiddleware),
}

Implementations§

Source§

impl GroupDef

Source

pub fn add<I: IntoGroupItem>(self, item: I) -> Self

Add an item (route or nested group) to this group

This is the primary method for adding items to a group. It accepts anything that implements IntoGroupItem, including routes created with get!, post!, etc., and nested groups created with group!.

Source

pub fn route<H, Fut>(self, route: RouteDefBuilder<H>) -> Self
where H: Fn(Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Add a route to this group (backward compatibility)

Prefer using .add() which accepts both routes and nested groups.

Source

pub fn middleware<M: Middleware + 'static>(self, middleware: M) -> Self

Add middleware to all routes in this group

Middleware is applied in the order it’s added.

§Example
group!("/api", {
    get!("/users", handler),
}).middleware(AuthMiddleware).middleware(RateLimitMiddleware)
Source

pub fn register(self, router: Router) -> Router

Register all routes in this group with the router

This prepends the group prefix to each route path and applies group middleware to all routes. Nested groups are flattened recursively, with prefixes concatenated and middleware inherited from parent groups.

§Path Combination
  • If route path is “/” (root), the full path is just the group prefix
  • Otherwise, prefix and route path are concatenated
§Middleware Inheritance

Parent group middleware is applied before child group middleware, which is applied before route-specific middleware.

Trait Implementations§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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