Struct amiya::Amiya

pub struct Amiya<Ex = ()> { /* fields omitted */ }

Amiya HTTP Server.

Amiya itself also implement the Middleware trait and can be added to another Amiya instance, see examples/subapp.rs for a example.

Implementations

impl<Ex> Amiya<Ex>

pub fn new() -> Self

Create a Amiya instance.

impl<Ex> Amiya<Ex> where
    Ex: Send + Sync + 'static, 

pub fn uses<M: Middleware<Ex> + 'static>(self, middleware: M) -> Self

Add a middleware to the end, middleware will be executed as the order of be added.

You can create middleware by implement the Middleware trait for your custom type or use the m macro to convert a async func or closure.

Examples

use amiya::m;

amiya::new().uses(m!(ctx => ctx.next().await));

use amiya::{m, middleware::Router};

let router = Router::new().endpoint().get(m!(
    ctx => ctx.resp.set_body("Hello world!");
));

amiya::new().uses(router);

impl<Ex> Amiya<Ex> where
    Ex: Default + Send + Sync + 'static, 

pub async fn listen<A: AsyncToSocketAddrs + Debug>(self, addr: A) -> Result<()>

Run Amiya server on given addr

Examples

amiya::new().listen("127.0.0.1:8080");

amiya::new().listen(("127.0.0.1", 8080));

use std::net::Ipv4Addr;

amiya::new().listen((Ipv4Addr::new(127, 0, 0, 1), 8080));

use std::net::{SocketAddrV4, Ipv4Addr};

let socket = SocketAddrV4::new(Ipv4Addr::new(127, 0, 0, 1), 8080);
amiya::new().listen(socket);

amiya::new().listen("[::]:8080");

Trait Implementations

impl<Ex> Default for Amiya<Ex>

fn default() -> Self

Returns the "default value" for a type.

impl<Ex: Send + Sync + 'static> Middleware<Ex> for Amiya<Ex>

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

You middleware's handler function, it will be called when request reach this middleware