Struct RouteHandle 

pub struct RouteHandle<'r> { /* private fields */ }

Returned by get/post/… so a route can be named after registration.

Implementations

impl RouteHandle<'_>

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

Name the route for url_for and route:list.

pub fn describe(self, summary: &str) -> Self

Say what this route does, in one line.

Documentation is attached here rather than kept in a separate file, so it cannot drift away from the route it describes.

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

Group this route under a heading in generated documentation.

pub fn responds(self, status: u16, description: &str) -> Self

Document a response this route can return.

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

Describe a parameter. Undescribed path parameters are still documented, just without prose.

pub fn deprecated(self) -> Self

Mark the route as deprecated in generated documentation.