Struct Route 

pub struct Route { /* private fields */ }

A declared route.

Implementations

impl Route

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

A route for methods at uri, served by handler.

HEAD is added alongside GET automatically, as every HTTP server is expected to answer a HEAD wherever it answers a GET.

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

Name the route, so it can be resolved into a URL.

pub fn middleware(&mut self, middleware: impl IntoMiddlewareStack) -> &mut Route

Attach middleware.

Takes the middleware itself — one instance, a tuple of them, or a whole MiddlewareStack from a group function. There is no name to misspell and no registry to look anything up in.

router.post("/login", login)
    .middleware(ThrottleRequests::per_minute(10));

router.get("/admin", dashboard)
    .middleware((Authenticate::new(auth), RequireRole::Admin));

router.get("/", home).middleware(kernel::web());

pub fn without_middleware<M>(&mut self) -> &mut Route

where M: Middleware,

Skip a middleware this route would otherwise inherit from its group.

By type, because that is the only identity a value has:

router.post("/webhooks/stripe", stripe)
    .without_middleware::<VerifyCsrfToken>();

Matches the concrete type, so excluding ThrottleRequests removes every rate limiter the group applied, not one particular configuration of it. Where that is too blunt, do not put it in the group.

pub fn where_param( &mut self, param: impl Into<String>, constraint: ParamConstraint, ) -> &mut Route

Constrain a route parameter.

pub fn where_number(&mut self, param: impl Into<String>) -> &mut Route

Constrain a parameter to digits.

pub fn where_slug(&mut self, param: impl Into<String>) -> &mut Route

Constrain a parameter to a slug.

pub fn where_uuid(&mut self, param: impl Into<String>) -> &mut Route

Constrain a parameter to a UUID.

pub fn where_in( &mut self, param: impl Into<String>, values: impl IntoIterator<Item = impl Into<String>>, ) -> &mut Route

Constrain a parameter to a fixed set of values.

pub fn methods(&self) -> &[Method]

The methods this route answers.

pub fn uri(&self) -> &str

The URI pattern, normalised to start with /.

pub fn segments(&self) -> &[Segment]

The compiled segments.

pub fn route_name(&self) -> Option<&str>

The route’s name, if it has one.

pub fn middleware_stack(&self) -> &MiddlewareStack

The middleware attached to this route, outermost first.

pub fn excluded_middleware(&self) -> &[TypeId]

The types this route opts out of.

pub fn handler(&self) -> &Arc<dyn RouteHandler>

The handler.

pub fn param_names(&self) -> Vec<&str>

The parameter names this route captures, in order.

pub fn match_path(&self, path: &str) -> Option<HashMap<String, String>>

Match path against this route’s pattern, returning the captured parameters. None if the shape differs or a constraint rejects a value.

pub fn matches_path_only(&self, path: &str) -> bool

Whether path matches, ignoring the method — used to answer 405 instead of 404 when a route exists but not for this method.

pub fn accepts(&self, method: &Method) -> bool

Whether this route answers method.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.