Struct poem::route::Route

pub struct Route { /* fields omitted */ }

Routing object

Implementations

impl Route

pub fn at(self, path: &str, ep: impl Endpoint) -> Self

Add an Endpoint to the specified path.

You can match the full path or wildcard path, and use the Path extractor to get the path parameters.

Example

use poem::{get, handler, route, web::Path};

#[handler]
async fn a() {}

#[handler]
async fn b(Path((group, name)): Path<(String, String)>) {}

#[handler]
async fn c(Path(path): Path<String>) {}

let app = route()
    // full path
    .at("/a/b", get(a))
    // capture parameters
    .at("/b/:group/:name", get(b))
    // capture tail path
    .at("/c/*path", get(c));

pub fn nest(self, path: &str, ep: impl Endpoint) -> Self

Nest a Endpoint to the specified path.

Trait Implementations

impl Default for Route

fn default() -> Route

Returns the “default value” for a type.

impl Endpoint for Route

fn call<'life0, 'async_trait>(
    &'life0 self,
    req: Request
) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the response to the request.