Trait highnoon::Endpoint

pub trait Endpoint<S: State> {
    fn call<'life0, 'async_trait>(
        &'life0 self,
        req: Request<S>
    ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        Self: 'async_trait;
}

Implement Endpoint for a type to be used as a method handler.

It is already implemented for functions of Request to Result<Response> which is the simplest (and most convenient) kind of handler. You can implement it manually for endpoints that may require some kind of local state.

Endpoint uses the #[async_trait] attribute hence the signature presented in the docs here has been modified. An example of implementing using the attribute:

struct NoOpEndpoint;

#[async_trait::async_trait]
impl<S: State> Endpoint<S> for NoOpEndpoint
{
    async fn call(&self, req: Request<S>) -> Result<Response> {
        Ok(Response::ok())
    }
}

Required Methods

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

Implementors

impl<H, F, S> Endpoint<S> for WsEndpoint<H, F, S>where
    S: State,
    H: Send + Sync + 'static + Fn(Request<S>, WebSocketSender, WebSocketReceiver) -> F,
    F: Future<Output = Result<()>> + Send + 'static,

impl<S, F, Fut, R> Endpoint<S> for Fwhere
    F: Send + Sync + 'static + Fn(Request<S>) -> Fut,
    Fut: Future<Output = R> + Send + 'static,
    R: Responder + 'static,
    S: State,