Struct RouteEntry 

pub struct RouteEntry {
    pub method: Method,
    pub path: String,
    /* private fields */
}

A registered route with its handler.

Fields

method: Method

The HTTP method for this route.

path: String

The path pattern for this route.

Implementations

impl RouteEntry

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

where H: Fn(&RequestContext, &mut Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Response> + Send + 'static,

Creates a new route entry from a handler whose future is 'static (it does not borrow the context or request beyond the call).

Plain fn(&RequestContext, &mut Request) -> Ready<Response> handlers and async fn handlers that clone what they need fit here. Handlers that must borrow ctx/req across an .await use RouteEntry::new_boxed.

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

where H: for<'a> Fn(&'a RequestContext, &'a mut Request) -> BoxFuture<'a, Response> + Send + Sync + 'static,

Creates a new route entry from a handler that returns a BoxFuture borrowing the context and request for the call’s duration.

This is the general form: extractor-based handlers await FromRequest on req and pass ctx.cx() through, so their futures are tied to the call. #[get]-style proc-macro routes are built this way via RouteEntry::from_route.

pub fn from_route<H>(route: Route, handler: H) -> Self

where H: for<'a> Fn(&'a RequestContext, &'a mut Request) -> BoxFuture<'a, Response> + Send + Sync + 'static,

Creates a new route entry from a fastapi_router::Route metadata object.

This is the constructor proc-macro generated routes use, since it preserves OpenAPI metadata (operation_id, tags, request body, etc). The handler has the borrowing form of RouteEntry::new_boxed.

pub fn route_meta(&self) -> Option<&Route>

Returns the preserved route metadata, if any.

pub async fn call(&self, ctx: &RequestContext, req: &mut Request) -> Response

Calls the handler with the given context and request.

Trait Implementations

impl Clone for RouteEntry

fn clone(&self) -> RouteEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteEntry

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

Formats the value using the given formatter.