Trait envoy_http::Endpoint

pub trait Endpoint: Send + Sync {
    fn call<'life0, 'life1, 'async_trait>(
        &'life0 self, 
        ctx: &'life1 mut Context
    ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>
    where
        'life0: 'async_trait,
        'life1: 'async_trait,
        Self: 'async_trait;
}

An HTTP request handler.

This trait is automatically implemented for Fn types, and so is rarely implemented directly by Envoy users.

In practice, endpoints are functions that take a Request as an argument and return a type T that implements Into<Response>.

Endpoints are implemented as asynchronous functions that make use of language features currently only available in Rust Nightly. For this reason, we have to explicitly enable the attribute will be omitted in most of the documentation.

A simple endpoint that is invoked on a GET request and returns a String:

async fn hello(ctx: &mut envoy::Context) -> envoy::Result {
    Ok(ctx.res.set_body(String::from("hello")))
}

let mut app = envoy::Server::new();
app.at("/hello").get(hello);

Required Methods

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

Invoke the endpoint within the given context

Trait Implementations

impl Debug for dyn Endpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Endpoint for Box<dyn Endpoint>

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

Invoke the endpoint within the given context

Implementations on Foreign Types

impl Endpoint for Box<dyn Endpoint>

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

Implementors

impl Endpoint for Server

impl<F> Endpoint for F where
    F: for<'a1> Fn1<&'a1 mut Context> + Sync + Send,
    for<'a1> <F as Fn1<&'a1 mut Context>>::Output: Future<Output = Result> + Send,