Struct highnoon::app::App

pub struct App<S: State> { /* fields omitted */ }

The main entry point to highnoon. An App can be launched as a server or mounted into another App. Each App has a chain of (Filters)Filter which are applied to each request.

Implementations

impl<S: State> App<S>

pub fn new(state: S) -> Self

Create a new App with the given state. State must be Send + Sync + 'static because it gets shared by all route handlers. If you need inner mutability use a Mutex or similar.

pub fn state(&self) -> &S

Get a reference to this App's state

pub fn with<F>(&mut self, filter: F) where
    F: Filter<S> + Send + Sync + 'static, 

Append a filter to the chain. Filters are applied to all endpoints in this app, and are applied in the order they are registered.

pub fn at<'a, 'p>(&'a mut self, path: &'p str) -> Route<'a, 'p, S>

Create a route at the given path. Returns a Route object on which you can attach handlers for each HTTP method

pub async fn listen(self, host: impl ToSocketAddrs) -> Result<()>

Start a server listening on the given address (See ToSocketAddrs from tokio) This method only returns if there is an error. (Graceful shutdown is TODO)

Trait Implementations

impl<S: State> Endpoint<S> for App<S>

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,