Trait poem::endpoint::Endpoint

pub trait Endpoint: Send + Sync {
    type Output: IntoResponse;

    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;

    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,
    { ... }
}

An HTTP request handler.

Required Associated Types

type Output: IntoResponse

Represents the response of the endpoint.

Required Methods

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.

Provided Methods

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.

Unlike Endpoint::call, when an error occurs, it will also convert the error into a response object.

Example

use poem::{
    error::NotFoundError, handler, http::StatusCode, test::TestClient, Endpoint, Request,
    Result,
};

#[handler]
fn index() -> Result<()> {
    Err(NotFoundError.into())
}

TestClient::new(index)
    .get("/")
    .send()
    .await
    .assert_status(StatusCode::NOT_FOUND);

Implementations on Foreign Types

impl<'impl0, T: Endpoint + ?Sized> Endpoint for &'impl0 T

type Output = <T as Endpoint>::Output

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,

impl<T: Endpoint + ?Sized> Endpoint for Box<T>

type Output = <T as Endpoint>::Output

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,

impl<T: Endpoint + ?Sized> Endpoint for Arc<T>

type Output = <T as Endpoint>::Output

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,

Implementors

impl Endpoint for Route

type Output = Response

impl Endpoint for RouteDomain

type Output = Response

impl Endpoint for RouteMethod

type Output = Response

impl Endpoint for RouteScheme

type Output = Response

impl Endpoint for StaticFileEndpoint

type Output = Response

impl Endpoint for StaticFilesEndpoint

type Output = Response

impl<E, F> Endpoint for InspectAllError<E, F>where
    E: Endpoint,
    F: Fn(&Error) + Send + Sync,

type Output = <E as Endpoint>::Output

impl<E, F, ErrType> Endpoint for InspectError<E, F, ErrType>where
    E: Endpoint,
    F: Fn(&ErrType) + Send + Sync,
    ErrType: Error + Send + Sync + 'static,

type Output = <E as Endpoint>::Output

impl<E, F, Fut> Endpoint for Before<E, F>where
    E: Endpoint,
    F: Fn(Request) -> Fut + Send + Sync,
    Fut: Future<Output = Result<Request>> + Send,

type Output = <E as Endpoint>::Output

impl<E, F, Fut, R> Endpoint for CatchAllError<E, F, R>where
    E: Endpoint,
    F: Fn(Error) -> Fut + Send + Sync,
    Fut: Future<Output = R> + Send,
    R: IntoResponse + Send + Sync,

type Output = Response

impl<E, F, Fut, R, ErrType> Endpoint for CatchError<E, F, R, ErrType>where
    E: Endpoint,
    F: Fn(ErrType) -> Fut + Send + Sync,
    Fut: Future<Output = R> + Send,
    R: IntoResponse + Send + Sync,
    ErrType: Error + Send + Sync + 'static,

type Output = Response

impl<E, F, Fut, R, R2> Endpoint for AndThen<E, F>where
    E: Endpoint<Output = R>,
    F: Fn(R) -> Fut + Send + Sync,
    Fut: Future<Output = Result<R2>> + Send,
    R: IntoResponse,
    R2: IntoResponse,

type Output = R2

impl<E, F, Fut, R, R2> Endpoint for Map<E, F>where
    E: Endpoint<Output = R>,
    F: Fn(R) -> Fut + Send + Sync,
    Fut: Future<Output = R2> + Send,
    R: IntoResponse,
    R2: IntoResponse,

type Output = R2

impl<E, F, Fut, T> Endpoint for After<E, F>where
    E: Endpoint,
    F: Fn(Result<E::Output>) -> Fut + Send + Sync,
    Fut: Future<Output = Result<T>> + Send,
    T: IntoResponse,

type Output = T

impl<E, F, Fut, T> Endpoint for Around<E, F>where
    E: Endpoint,
    F: Fn(Arc<E>, Request) -> Fut + Send + Sync + 'static,
    Fut: Future<Output = Result<T>> + Send,
    T: IntoResponse,

type Output = T

impl<E, T> Endpoint for AddDataEndpoint<E, T>where
    E: Endpoint,
    T: Clone + Send + Sync + 'static,

type Output = <E as Endpoint>::Output

impl<E: RustEmbed + Send + Sync> Endpoint for EmbeddedFileEndpoint<E>

type Output = Response

impl<E: RustEmbed + Send + Sync> Endpoint for EmbeddedFilesEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for CompressionEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for CookieJarManagerEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for CorsEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for CsrfEndpoint<E>

type Output = <E as Endpoint>::Output

impl<E: Endpoint> Endpoint for NormalizePathEndpoint<E>

type Output = <E as Endpoint>::Output

impl<E: Endpoint> Endpoint for OpenTelemetryMetricsEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for PropagateHeaderEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for SensitiveHeaderEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for SetHeaderEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for SizeLimitEndpoint<E>

type Output = <E as Endpoint>::Output

impl<E: Endpoint> Endpoint for TokioMetricsEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for TracingEndpoint<E>

type Output = Response

impl<E: Endpoint> Endpoint for CookieSessionEndpoint<E>

Available on crate feature session only.

type Output = <E as Endpoint>::Output

impl<E: Endpoint> Endpoint for MapToResponse<E>

type Output = Response

impl<E: Endpoint> Endpoint for ToResponse<E>

type Output = Response

impl<E: Endpoint, H: PanicHandler> Endpoint for CatchPanicEndpoint<E, H>

type Output = Response

impl<T, E> Endpoint for OpenTelemetryTracingEndpoint<T, E>where
    T: Tracer + Send + Sync,
    T::Span: Send + Sync + 'static,
    E: Endpoint,

type Output = Response

impl<T, E> Endpoint for ServerSessionEndpoint<T, E>where
    T: SessionStorage,
    E: Endpoint,

Available on crate feature session only.

type Output = <E as Endpoint>::Output