Struct Route 

pub struct Route { /* private fields */ }

A single route: an HTTP method, a path pattern, a handler, and metadata.

The path is local to the router that owns the route until the router tree is flattened, at which point enclosing prefixes are prepended.

Implementations

impl Route

pub fn new(method: Method, path: impl Into<String>, handler: HandlerFn) -> Self

Creates a route for method at the local path, served by handler.

pub fn on_request<F, Fut>(self, hook: F) -> Self

where F: Fn(RequestEvent) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a scoped, observe-only on_request hook.

Scoped hooks run in addition to the app-global ones, after routing.

pub fn on_response<F, Fut>(self, hook: F) -> Self

where F: Fn(ResponseEvent) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a scoped, observe-only on_response hook.

pub fn on_error<F, Fut>(self, hook: F) -> Self

where F: Fn(ErrorEvent) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a scoped, observe-only on_error hook (non-validation errors).

pub fn on_validation_error<F, Fut>(self, hook: F) -> Self

where F: Fn(ValidationErrorEvent) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Registers a scoped, observe-only on_validation_error hook.

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

Sets the operation summary.

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

Sets the operation description.

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

Adds a single tag to the route.

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

Sets the default success status code.

pub fn response_model<T: ?Sized>(self) -> Self

Records the response model type name for documentation.

pub fn request_schema<T: JsonSchema>(self) -> Self

Records the request body schema generator.

pub fn request_schema_fn(self, thunk: SchemaThunk) -> Self

Records the request body schema generator from a thunk (for form bodies).

pub fn request_kind(self, kind: RequestBodyKind) -> Self

Sets the request body encoding (application/json by default).

pub fn response_schema<T: JsonSchema>(self) -> Self

Records the success response body schema generator.

pub fn streaming(self) -> Self

Marks the response as a stream (documented as text/event-stream).

pub fn websocket(self) -> Self

Marks the route as a WebSocket endpoint (documented as an AsyncAPI channel).

pub fn ws_incoming<T: JsonSchema>(self) -> Self

Records the schema of messages the WebSocket receives.

pub fn ws_outgoing<T: JsonSchema>(self) -> Self

Records the schema of messages the WebSocket sends.

pub fn method(&self) -> &Method

Returns the HTTP method.

pub fn path(&self) -> &str

Returns the (possibly prefixed) path pattern.

pub fn meta(&self) -> &RouteMeta

Returns the route’s introspection metadata.

pub fn handler(&self) -> &HandlerFn

Returns the type-erased handler.

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.