tempbottle / rustful

A light web micro-framework for Rust

Rustful

A light web micro-framework for Rust with REST-like features. The main purpose of Rustful is to create a simple, modular and non-intrusive foundation for HTTP applications. It has a mainly stateless structure, which naturally allows it to run both as one single server and as multiple instances in a cluster.

Some of the features are:

• Generic response handlers. Just use a function or implement the Handler trait.
• Unified log system to make sure everything is working together.
• Some handy macros reduces the risk for typos and makes life easier.
• Pluggable request and response filtering.
• Variables and recursive wildcards in routes.

Online documentation.

#Getting Started

##Cargo.toml Entries

Add the following lines to your Cargo.toml file:

[dependencies]
rustful = "0.3"

###Cargo Features

Some parts of Rustful can be toggled using Cargo features:

• rustc_json_body - Parse the request body as JSON. Enabled by default.
• ssl - Enable SSL, and thereby HTTPS. Enabled by default.
• multipart - Enable parsing of multipart/form-data requests. Enabled by default.

###Using SSL Note that the ssl feature requires OpenSSL to be installed in one way or another. See https://github.com/sfackler/rust-openssl#building for more instructions.

##Write Your Server Here is a simple example of what a simple project could look like. Visit http://localhost:8080 or http://localhost:8080/Olivia (if your name is Olivia) to try it.

//Include macros to be able to use `insert_routes!`.
#[macro_use]
extern crate rustful;

use std::error::Error;

use rustful::{Server, Context, Response, TreeRouter, Handler};

fn say_hello(context: Context, response: Response) {
    //Get the value of the path variable `:person`, from below.
    let person = match context.variables.get("person") {
        Some(name) => &name[..],
        None => "stranger"
    };

    //Use the name from the path variable to say hello.
    response.send(format!("Hello, {}!", person));
}

//Dodge an ICE, related to functions as handlers.
struct HandlerFn(fn(Context, Response));

impl Handler for HandlerFn {
    fn handle_request(&self, context: Context, response: Response) {
        self.0(context, response);
    }
}

fn main() {
    //Build and run the server.
    let server_result = Server {
        //Turn a port number into an IPV4 host address (0.0.0.0:8080 in this case).
        host: 8080.into(),

        //Create a TreeRouter and fill it with handlers.
        handlers: insert_routes!{
            TreeRouter::new() => {
                //Handle requests for root...
                Get: HandlerFn(say_hello),

                //...and one level below.
                //`:person` is a path variable and it will be accessible in the handler.
                ":person" => Get: HandlerFn(say_hello)
            }
        },

        //Use default values for everything else.
        ..Server::default()
    }.run();

    match server_result {
        Ok(_server) => {},
        Err(e) => println!("could not start server: {}", e.description())
    }
}

##Contributing

Contributions are always welcome, even if it's a small typo fix (or maybe I should say "especially typo fixes"). You can fork the project and open a pull request with your changes, or create an issue if you just want to report or request something. Are you not sure about how to implement your change? Is it still a work in progress? Don't worry. You can still open a pull request where we can discuss it and do it step by step.

New features are as welcome as fixes, so pull requests and proposals with enhancements are very much appreciated, but please explain your feature and give a good motivation to why it should be included. It makes things much easier, both for reviewing the feature and for those who are not as familiar with how things work. You can always open an issue where we can discuss the feature and see if it should be included. Asking is better than assuming!

###Testing

Rustful is tested on Linux, using Travis, and on Windows, using AppVeyor and a pull request will not be approved unless it passes these tests. It is therefore a good idea to run tests locally, before pushing your changes, so here is a small list of useful commands:

• cargo test - Basic unit, documentation and compile tests.
• cargo build --no-default-features - Check if the most minimal version of Rustful builds.
• cargo build --no-default-features --features "feature1 feature2" - Check if Rustful with only feature1 and feature2 enabled builds.
• cargo run --example example_name - check if the example example_name behaves as expected (see the example directory).