Struct poem::RouteMethod

pub struct RouteMethod { /* private fields */ }

Routing object for HTTP methods

Errors

• MethodNotAllowedError

Example

use poem::{
    handler,
    http::{Method, StatusCode},
    Endpoint, Request, RouteMethod,
};

#[handler]
fn handle_get() -> &'static str {
    "get"
}

#[handler]
fn handle_post() -> &'static str {
    "post"
}

let route_method = RouteMethod::new().get(handle_get).post(handle_post);

let resp = route_method
    .get_response(Request::builder().method(Method::GET).finish())
    .await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.into_body().into_string().await.unwrap(), "get");

let resp = route_method
    .get_response(Request::builder().method(Method::POST).finish())
    .await;
assert_eq!(resp.status(), StatusCode::OK);
assert_eq!(resp.into_body().into_string().await.unwrap(), "post");

let resp = route_method
    .get_response(Request::builder().method(Method::PUT).finish())
    .await;
assert_eq!(resp.status(), StatusCode::METHOD_NOT_ALLOWED);

Implementations

impl RouteMethod

pub fn new() -> Self

Create a RouteMethod object.

pub fn method<E>(self, method: Method, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for the specified method.

pub fn get<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for GET.

pub fn post<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for POST.

pub fn put<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for PUT.

pub fn delete<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for DELETE.

pub fn head<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for HEAD.

pub fn options<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for OPTIONS.

pub fn connect<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for CONNECT.

pub fn patch<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for PATCH.

pub fn trace<E>(self, ep: E) -> Self

where E: IntoEndpoint, E::Endpoint: 'static,

Sets the endpoint for TRACE.

Trait Implementations

impl Default for RouteMethod

fn default() -> RouteMethod

Returns the “default value” for a type.

impl Endpoint for RouteMethod

type Output = Response

Represents the response of the endpoint.

fn call( &self, req: Request ) -> impl Future<Output = Result<Self::Output>> + Send

Get the response to the request.

fn get_response(&self, req: Request) -> impl Future<Output = Response> + Send

Get the response to the request and return a Response.