rocket 0.3.16

Web framework for nightly with a focus on ease-of-use, expressibility, and speed.
docs.rs failed to build rocket-0.3.16
Please check build logs and if you believe this is docs.rs' fault, report into this issue report.

Rocket - Core API Documentation

Hello, and welcome to the core Rocket API documentation!

This API documentation is highly technical and is purely a reference. There's an overview of Rocket on the main site as well as a full, detailed guide. If you'd like pointers on getting started, see the quickstart or getting started chapters of the guide.

You may also be interested in looking at the contrib API documentation, which contains JSON and templating support, among other features.

Libraries

Rocket's functionality is split into three crates:

  1. Core - The core library. Needed by every Rocket application.
  2. Codegen - Core code generation plugin. Should always be used alongsize rocket, though it's not necessary.
  3. Contrib - Provides useful functionality for many Rocket applications. Completely optional.

Usage

The sanctioned way to use Rocket is via the code generation plugin. This makes Rocket easier and safer to use and allows a somewhat stable API as Rocket matures. To use Rocket with the code generation plugin in your Cargo-based project, add the following to Cargo.toml:

[dependencies]
rocket = "*"
rocket_codegen = "*"

If you'll be deploying your project to crates.io, you'll need to change the "*" to the current version of Rocket.

Then, add the following to the top of your main.rs file:

#![feature(plugin)]
# #![allow(unused_attributes)]
#![plugin(rocket_codegen)]

extern crate rocket;

See the guide for more information on how to write Rocket applications. Here's a simple example to get you started:

#![feature(plugin)]
#![plugin(rocket_codegen)]

extern crate rocket;

#[get("/")]
fn hello() -> &'static str {
    "Hello, world!"
}

fn main() {
# if false { // We don't actually want to launch the server in an example.
    rocket::ignite().mount("/", routes![hello]).launch();
# }
}

Configuration

Rocket and Rocket libraries are configured via the Rocket.toml file and/or ROCKET_{PARAM} environment variables. For more information on how to configure Rocket, see the configuration section of the guide as well as the config module documentation.

Testing

The local module contains structures that facilitate unit and itegration testing of a Rocket application. The top-level local module documentation and the testing chapter of the guide include detailed examples.