Adding `mini_async_http` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add mini_async_http

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

mini_async_http = "0.1.0"

The mini_async_http library will be automatically available globally. Read the mini_async_http library documentation.

Back to the crate overview.

Readme

mini-async-http

mini-async-http is a tiny http server. I have built it in order to practive and learn the rust language. It is based on the mio library for all that is related to async io.

Example

You can create a server with the following code :

extern crate mini_async_http;

use mini_async_http::AIOServer;
use mini_async_http::ResponseBuilder;

pub fn main(){
    let mut server = AIOServer::new(3, "0.0.0.0:7878", move |request|{
        ResponseBuilder::empty_200()
            .body(b"Hello")
            .content_type("text/plain")
            .build()
            .unwrap()
    });

    server.start();
}

Here the server is created with 3 worker threads and will bind to the port 7878. When a new request is received, the response body is set to "Hello" and sent.

You can share a state between the calls with the usual rust sync mechanism. Here is an example with a simple counter that is incremented on every request :

extern crate mini_async_http;

use mini_async_http::AIOServer;
use mini_async_http::ResponseBuilder;
use std::sync::{Arc, Mutex};

pub fn main() {
    let counter = Arc::from(Mutex::from(0));

    let mut server = AIOServer::new(3, "0.0.0.0:7878", move |request| {
        let lock = counter.clone();
        let mut counter = lock.lock().unwrap();

        let body = counter.to_string();
        *counter += 1;

        ResponseBuilder::empty_200()
            .body(body.as_bytes())
            .content_type("text/plain")
            .build()
            .unwrap()
    });

    server.start();
}

Architecture

This implementation is based on mio. All the new connection and requests are handled by an event loop. The event loop is handling 4 different type of event :

New connection : when a new client is connecting, the resulting tcp stream is registered in the mio registry in order to be notified when data is received through this connection.
New data : A stream is available to be read. The stream is sent to the worler pool to be handled.
Closed connection : A connection has been closed either by the client or the server itself. It must be removed from the watch list and dropped.
Server shutdown : The server is shutting down, it is now waiting on the worker threads to stop to end the event loop

It is important that no calculation is done in the event loop as it is the core of the server performance.

Adding mini_async_http library as a dependency

Adding `mini_async_http` library as a dependency