Crate rocket [−] [src]
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:
- Core - The core library. Needed by every Rocket application.
- Codegen - Core code generation plugin. Should always
be used alongsize
rocket
, though it's not necessary. - 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)] #![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() { 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
Rocket includes a small testing library that can be used to test your Rocket application. For information on how to test your Rocket applications, see the testing module documentation.
Modules
config |
Application configuration and configuration parameter retrieval. |
data |
Types and traits for reading and parsing request body data. |
handler |
The types of request and error handlers and their return values. |
http |
Types that map to concepts in HTTP. |
outcome |
Success, failure, and forward handling. |
request |
Types and traits for request parsing and handling. |
response |
Types and traits to build and send responses. |
Structs
Catcher |
An error catching route. |
Data |
Type representing the data in the body of an incoming request. |
Request |
The type of an incoming web request. |
Response |
An HTTP/Rocket response, returned by |
Rocket |
The main |
Route |
A route: a method, its handler, path, rank, and format/content type. |
State |
Request guard to retrieve managed state. |
Enums
Error |
[unstable] Error type for Rocket. Likely to change. |
LoggingLevel |
Defines the different levels for log messages. |
Outcome |
An enum representing success ( |
Functions
custom |
Alias to Rocket::custom().
Creates a new instance of |
ignite |
Alias to Rocket::ignite().
Creates a new instance of |
Type Definitions
ErrorHandler |
The type of an error handler. |
Handler |
The type of a request handler. |