Struct poem::RouteDomain

pub struct RouteDomain { /* private fields */ }

Routing object for HOST header

Errors

• NotFoundError

Example

use poem::{endpoint::make_sync, handler, http::header, Endpoint, Request, RouteDomain};

let app = RouteDomain::new()
    .at("example.com", make_sync(|_| "1"))
    .at("www.+.com", make_sync(|_| "2"))
    .at("*.example.com", make_sync(|_| "3"))
    .at("*", make_sync(|_| "4"));

fn make_request(host: &str) -> Request {
    Request::builder().header(header::HOST, host).finish()
}

async fn do_request(app: &RouteDomain, req: Request) -> String {
    app.call(req)
        .await
        .unwrap()
        .into_body()
        .into_string()
        .await
        .unwrap()
}

assert_eq!(do_request(&app, make_request("example.com")).await, "1");
assert_eq!(do_request(&app, make_request("www.abc.com")).await, "2");
assert_eq!(do_request(&app, make_request("a.b.example.com")).await, "3");
assert_eq!(do_request(&app, make_request("rust-lang.org")).await, "4");
assert_eq!(do_request(&app, Request::default()).await, "4");

Implementations

impl RouteDomain

pub fn new() -> Self

Create a RouteDomain object.

pub fn at<E>(self, pattern: impl AsRef<str>, ep: E) -> Self where
    E: IntoEndpoint,
    E::Endpoint: 'static, 

Add an Endpoint to the specified domain pattern.

Panics

Panic when there are duplicates in the routing table.

pub fn try_at<E>(
    self,
    pattern: impl AsRef<str>,
    ep: E
) -> Result<Self, RouteError> where
    E: IntoEndpoint,
    E::Endpoint: 'static, 

Attempts to add an Endpoint to the specified domain pattern.

Trait Implementations

impl Default for RouteDomain

fn default() -> RouteDomain

Returns the “default value” for a type.

impl Endpoint for RouteDomain

type Output = Response

Represents the response of the endpoint.

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

Get the response to the request.

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

Get the response to the request and return a Response.