Struct poem::RouteDomain

pub struct RouteDomain { /* private fields */ }

Routing object for HOST header

Errors

• NotFoundError

Example

use poem::{
    endpoint::make_sync,
    handler,
    http::header,
    test::{TestClient, TestRequestBuilder},
    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"));

async fn check(app: impl Endpoint, domain: Option<&str>, res: &str) {
    let cli = TestClient::new(app);
    let mut req = cli.get("/");
    if let Some(domain) = domain {
        req = req.header(header::HOST, domain);
    }
    let resp = req.send().await;
    resp.assert_status_is_ok();
    resp.assert_text(res).await;
}

check(&app, Some("example.com"), "1").await;
check(&app, Some("www.abc.com"), "2").await;
check(&app, Some("a.b.example.com"), "3").await;
check(&app, Some("rust-lang.org"), "4").await;
check(&app, None, "4").await;

Implementations

impl RouteDomain

pub fn new() -> Self

Create a RouteDomain object.

pub fn at<E>(self, pattern: impl AsRef<str>, ep: E) -> Selfwhere
    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.