Struct MethodRouter 

pub struct MethodRouter { /* private fields */ }

Maps HTTP methods to handlers for a single path.

Implementations

impl MethodRouter

pub fn get<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route GET requests to handler.

pub fn post<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route POST requests to handler.

pub fn put<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route PUT requests to handler.

pub fn patch<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route PATCH requests to handler.

pub fn delete<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route DELETE requests to handler.

pub fn head<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route HEAD requests to handler.

pub fn options<H: Handler<T>, T: 'static>(self, handler: H) -> Self

Additionally route OPTIONS requests to handler.

impl MethodRouter

pub fn on<H: Handler<T>, T: 'static>(self, method: Method, handler: H) -> Self

Route method to handler. Methods outside GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS and TRACE are rejected when the app is built.

pub fn layer<L>(self, layer: L) -> Self

where L: Layer<BoxService>, L::Service: Service<Request, Response = Response, Error = Infallible> + Clone + Send + Sync + 'static, <L::Service as Service<Request>>::Future: Send + 'static,

Wrap every handler added so far in layer.

The layer runs after routing and only for this path, so it can be used for per-route middleware such as siderite_cache::RouteCache. Handlers added after this call are not wrapped.

pub fn summary(self, summary: impl Into<String>) -> Self

Set the summary.

pub fn description(self, description: impl Into<String>) -> Self

Set the description.

pub fn tag(self, tag: impl Into<String>) -> Self

Add a tag.

pub fn operation_id(self, id: impl Into<String>) -> Self

Set the operation id.

pub fn deprecated(self) -> Self

Mark deprecated.

pub fn hidden(self) -> Self

Hide from the OpenAPI document.

pub fn status(self, status: StatusCode) -> Self

Success status: replaces a 200 OK produced by the handler at runtime, and documents the success response under this code.

pub fn response_model<T: Schema + 'static>(self) -> Self

Document the success response body as T (application/json), independent of the handler’s return type.

Trait Implementations

impl Clone for MethodRouter

fn clone(&self) -> MethodRouter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MethodRouter

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

Formats the value using the given formatter.

impl Default for MethodRouter

fn default() -> MethodRouter

Returns the “default value” for a type.