thruster 0.4.3

A middleware based http async web server.
Documentation

Thruster

An opinionated framework for web development in rust.

Build Status

thruster is a web framework that aims for developers to be productive and consistent across projects and teams. Its goals are to be:

  • Opinionated
  • Fast
  • Intuitive

Opinionated

thruster and thruster-cli strive to give a good way to do domain driven design. It's also designed to set you on the right path, but not obfuscate certain hard parts behind libraries. Made with science 🔭, not magic 🧙‍♂️.

Fast

Using the following wrk command, here are the results in hello_world examples for various frameworks

wrk -t12 -c400 -d30s http://127.0.0.1:4321/plaintext
>>> Framework: Cowboy
Requests/sec:  12374.60
Transfer/sec:      1.54MB
>>> Framework: Phoenix/Elixir (prod mode)
Requests/sec:    530.35
Transfer/sec:    131.03KB
>>> Framework: Rocket (prod mode)
Requests/sec:  31807.87
Transfer/sec:      4.43MB
>>> Framework: Thruster (dev mode)
Requests/sec:  12372.31
Transfer/sec:      1.75MB
>>> Framework: Thruster (prod mode)
Requests/sec:  51291.43
Transfer/sec:      7.24MB

Intuitive

Based on frameworks like Koa, and Express, thruster aims to be a pleasure to develop with.

Getting Started

The most basic example

extern crate thruster;
extern crate futures;
extern crate serde;
extern crate serde_json;
extern crate tokio;

use std::boxed::Box;
use futures::future;

use thruster::{App, BasicContext as Ctx, MiddlewareChain, MiddlewareReturnValue, Request};

fn generate_context(request: &Request) -> Ctx {
  Ctx {
    body: "".to_owned(),
    params: request.params().clone()
  }
}

fn plaintext(mut context: Ctx, _chain: &MiddlewareChain<Ctx>) -> MiddlewareReturnValue<Ctx> {
  let val = "Hello, World!".to_owned();
  context.body = val;

  Box::new(future::ok(context))
}

fn main() {
  println!("Starting server...");

  let mut app = App::<Ctx>::create(generate_context);

  app.get("/plaintext", vec![plaintext]);

  App::start(app, "0.0.0.0", 4321);
}

Quick setup without a DB

The easiest way to get started is to just clone the starter kit

> git clone git@github.com:trezm/thruster-starter-kit.git
> cd thruster-starter-kit
> cargo run

The example provides a simple plaintext route, a route with JSON serialization, and the preferred way to organize sub routes using sub apps.

Quick setup with postgres

The easiest way to get started with postgres is to install thruster-cli,

> cargo install thruster-cli

And then to run

> thruster-cli init MyAwesomeProject
> thruster-cli component Users
> thruster-cli migrate

Which will generate everything you need to get started! Note that this requires a running postgres connection and assumes the following connection string is valid:

postgres://postgres@localhost/<Your Project Name>

This is all configurable and none of it is hidden from the developer. It's like seeing the magic trick and learning how it's done! Check out the docs for thruster-cli here.