Crate octane

Octane is a web server that's modelled after express (a very popular and easy to use web framework) for rust.

While minimising dependencies, Octane thrives to be a high performance web server while being easy to use at the same time.

You can find other docs at the OctaneSite.

Example

Get started by adding the lib entry in your cargo.toml file

octane = "0.1.1"

and then in your main.rs,

use octane::server::Octane;
use octane::config::Config;
use octane::{route, router::{Flow, Route}};

fn main() {
    let mut app = Octane::new();
    app.add(Octane::static_dir("dir_name")); // serve a static directory
    app.get(
        "/",
        route!(
            |req, res| {
                res.send("Hello, World");
                Flow::Stop
            }
        ),
    );

    app.listen(8080).expect("Cannot establish connection");
}

and now you can see the page at http://0.0.0.0:8080.

Features

Octane divides most of the things that one might leave out for any reason into features. These include,

• faithful:
• query_strings:
• cookies: Basic cookie parsing and value handling.
• url_variables: To support variables in url.
• raw_headers:
• rustls: To use rustls for ssl.
• openSSL: To use openssl for ssl.
• 'default`: The default set includes faithful, query_strings, cookies, url_variables, raw_headers.

Note: If both rustls and openSSL features are enabled then octane will throw a compile_error!

Re-exports

pub use octane_json as json;

Modules

config
constants
cookies
error
file_handler
http
middlewares
path
query
request
responder
router
server
time
tls
util

Macros

declare_error
default
deref
display
inject_method
route	The route macro makes it easy to pass anonymous functions to app.METHODs.