Struct GroupDef 

pub struct GroupDef { /* private fields */ }

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

impl GroupDef

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!.

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.

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)

pub fn mcp_tool_name(self, name: &str) -> Self

Set a default MCP tool name for all routes in this group

Route-level overrides take precedence.

pub fn mcp_description(self, desc: &str) -> Self

Set a default MCP description for all routes in this group

Route-level overrides take precedence.

pub fn mcp_hint(self, hint: &str) -> Self

Set a default MCP hint for all routes in this group

Route-level overrides take precedence.

pub fn mcp_hidden(self) -> Self

Hide all routes in this group from MCP tool discovery

Route-level overrides take precedence.

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 the route path is "/" and the accumulated group prefix is non-empty, the handler is registered under both /prefix and /prefix/ so it is reachable at either URL. Route introspection and named-route lookup still report one canonical entry at /prefix (no trailing slash).
• A single trailing / on the group prefix is stripped before concatenation, so group!("/api/", { get!("/x", ...) }) produces /api/x rather than /api//x.
• A root prefix "/" combined with a root route "/" stays "/" (no "//" is ever registered).

Middleware Inheritance

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

Trait Implementations

impl IntoGroupItem for GroupDef

fn into_group_item(self) -> GroupItem

Convert this value into a group item for the route builder.