Struct Router

pub struct Router { /* private fields */ }

A routes collection.

Implementations

impl Router

pub const fn new() -> Self

Creates an empty Router.

pub fn route<S>(self, path: S, route: Route) -> Self

where S: AsRef<str>,

Inserts a path-route pair into the router.

pub fn resources<S>(self, path: S, resource: Resources) -> Self

where S: AsRef<str>,

Nested resources with a path.

pub fn nest<S>(self, path: S, router: Self) -> Self

where S: AsRef<str>,

Nested sub-router with a path.

pub fn get<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP GET verb pair.

pub fn post<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP POST verb pair.

pub fn put<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP PUT verb pair.

pub fn delete<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP DELETE verb pair.

pub fn head<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP HEAD verb pair.

pub fn options<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP OPTIONS verb pair.

pub fn connect<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP CONNECT verb pair.

pub fn patch<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP PATCH verb pair.

pub fn trace<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and HTTP TRACE verb pair.

pub fn any<S, H, O>(self, path: S, handler: H) -> Self

where S: AsRef<str>, H: Handler<Request, Output = Result<O>> + Clone, O: IntoResponse + Send + 'static,

Adds a handler with a path and any HTTP verbs.“

pub fn map_handler<F>(self, f: F) -> Self

where F: Fn(BoxHandler<Request, Result<Response>>) -> BoxHandler<Request, Result<Response>>,

Takes a closure and creates an iterator which calls that closure on each handler.

pub fn with<T>(self, t: T) -> Self

where T: Transform<BoxHandler>, T::Output: Handler<Request, Output = Result<Response>> + Clone,

Transforms the types to a middleware and adds it.

pub fn with_handler<H>(self, f: H) -> Self

where H: Handler<Next<Request, BoxHandler>, Output = Result<Response>> + Clone,

Adds a middleware for the routes.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Router

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

Formats the value using the given formatter.

impl Default for Router

fn default() -> Router

Returns the “default value” for a type.

impl From<Router> for Tree

fn from(router: Router) -> Self

Converts to this type from the input type.