Struct Router 

pub struct Router { /* private fields */ }

The route table under declaration.

Implementations

impl Router

pub fn resource(&mut self, name: &str, controller: Arc<dyn ResourceController>)

Register all seven RESTful routes for name.

pub fn api_resource( &mut self, name: &str, controller: Arc<dyn ResourceController>, )

Register the five API routes for name — everything except the create and edit form pages.

pub fn resource_actions( &mut self, name: &str, controller: Arc<dyn ResourceController>, actions: &[ResourceAction], )

Register exactly the listed actions.

They are always registered in ResourceAction::ALL order regardless of the order given, because /posts/create must be declared before /posts/{post} or the parameter swallows it.

impl Router

pub fn new() -> Router

An empty router.

pub fn add<H, Args>( &mut self, methods: Vec<Method>, uri: impl Into<String>, handler: H, ) -> &mut Route

where H: IntoRouteHandler<Args>,

Register a route for methods, returning it for further configuration.

pub fn add_erased( &mut self, methods: Vec<Method>, uri: impl Into<String>, handler: Arc<dyn RouteHandler>, ) -> &mut Route

Register a route from an already-erased handler.

The path resource routes and other generated routes take, where the handler was built dynamically rather than inferred from a function signature.

pub fn get<H, Args>(&mut self, uri: impl Into<String>, handler: H) -> &mut Route

where H: IntoRouteHandler<Args>,

GET (and HEAD).

pub fn post<H, Args>( &mut self, uri: impl Into<String>, handler: H, ) -> &mut Route

where H: IntoRouteHandler<Args>,

POST.

pub fn put<H, Args>(&mut self, uri: impl Into<String>, handler: H) -> &mut Route

where H: IntoRouteHandler<Args>,

PUT.

pub fn patch<H, Args>( &mut self, uri: impl Into<String>, handler: H, ) -> &mut Route

where H: IntoRouteHandler<Args>,

PATCH.

pub fn delete<H, Args>( &mut self, uri: impl Into<String>, handler: H, ) -> &mut Route

where H: IntoRouteHandler<Args>,

DELETE.

pub fn options<H, Args>( &mut self, uri: impl Into<String>, handler: H, ) -> &mut Route

where H: IntoRouteHandler<Args>,

OPTIONS.

pub fn any<H, Args>(&mut self, uri: impl Into<String>, handler: H) -> &mut Route

where H: IntoRouteHandler<Args>,

Every common method.

pub fn redirect( &mut self, from: impl Into<String>, to: impl Into<String>, ) -> &mut Route

A permanent redirect from from to to.

pub fn fallback<H, Args>(&mut self, handler: H)

where H: IntoRouteHandler<Args>,

The handler for requests that match nothing.

Without one, an unmatched request is a plain 404.

pub fn group( &mut self, attributes: GroupAttributes, declare: impl FnOnce(&mut Router), )

Declare routes that share a prefix, a name prefix, middleware, or parameter constraints.

Groups nest: the attributes are applied to every route the closure added, after any inner group has applied its own — so the outer prefix ends up outermost and the outer middleware runs first.

pub fn merge(&mut self, other: Router)

Merge another router’s routes into this one, keeping their order.

pub fn routes(&self) -> &[Route]

Every declared route, in declaration order.

pub fn routes_mut(&mut self) -> &mut [Route]

Mutable access to the declared routes.

pub fn len(&self) -> usize

How many routes are declared.

pub fn is_empty(&self) -> bool

Whether no routes are declared.

pub fn uri_for(&self, name: &str) -> Option<&str>

The URI pattern of a named route.

pub fn named_routes(&self) -> Vec<(&str, &str)>

Every named route, as (name, uri).

pub fn describe(&self) -> Vec<RouteSummary>

The route table, without compiling anything.

CompiledRouter::describe needs a container, because compiling builds every middleware stage — and a deferred stage that resolves a service will fail if that service is not bound. That is the right behaviour before serving traffic and the wrong behaviour for a question as harmless as “what routes are there?”.

So route:list, a documentation generator and a test asserting on the table can all ask here. The middleware column is the declared labels, which is what those callers wanted to read anyway.

pub fn compile(self, container: &Container) -> Result<CompiledRouter, Error>

Build every route’s pipeline.

Takes no registry: a route holds its middleware, so there is nothing to look up. It takes the container, because this is where every deferred stage is built — the point in the lifecycle where the container is populated and no request has arrived yet.

Trait Implementations

impl Default for Router

fn default() -> Router

Returns the “default value” for a type.