Github url

Rocket

by SergioBenitez

SergioBenitez /Rocket

A web framework for Rust.

10.3K Stars 691 Forks Last release: about 2 months ago (v0.4.5) Other 1.5K Commits 52 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Rocket

Build StatusRocket HomepageCurrent Crates.io VersionMatrix: #rocket:mozilla.orgIRC: #rocket on chat.freenode.net

Rocket is a web framework for Rust (nightly) with a focus on ease-of-use, expressibility, and speed. Here's an example of a complete Rocket application:

#[macro\_use] extern crate rocket; #[get("/<name>/<age>")]
fn hello(name: String, age: u8) -&gt; String {
    format!("Hello, {} year old named {}!", age, name)
}

#[launch]
fn rocket() -&gt; rocket::Rocket {
    rocket::ignite().mount("/hello", routes![hello])
}
</age></name>

Visiting

localhost:8000/hello/John/58

, for example, will trigger the

hello

route resulting in the string

Hello, 58 year old named John!

being sent to the browser. If an

<age></age>

string was passed in that can't be parsed as a

u8

, the route won't get called, resulting in a 404 error.

Documentation

Rocket is extensively documented:

The official community support channels are [

#rocket:mozilla.org

](https://chat.mozilla.org/#/room/#rocket:mozilla.org) on Matrix and the bridged [

#rocket

](https://kiwiirc.com/client/chat.freenode.net/#rocket) IRC channel on Freenode at

chat.freenode.net

. We recommend joining us on Matrix via Riot. If your prefer IRC, you can join via the Kiwi IRC client or a client of your own.

Building

Nightly

Rocket requires a nightly version of Rust as it makes heavy use of syntax extensions. This means that the first two unwieldly lines in the introductory example above are required.

Core, Codegen, and Contrib

All of the Rocket libraries are managed by Cargo. As a result, compiling them is simple.

  • Core:
    cd lib && cargo build
  • Codegen:
    cd codegen && cargo build
  • Contrib:
    cd contrib && cargo build --all-features

Examples

Rocket ships with an extensive number of examples in the

examples/

directory which can be compiled and run with Cargo. For instance, the following sequence of commands builds and runs the

Hello, world!

example:

cd examples/hello\_world cargo run

You should see

Hello, world!

by visiting

http://localhost:8000

.

Testing

To test Rocket, simply run

./scripts/test.sh

from the root of the source tree. This will build and test the

core

,

codegen

, and

contrib

libraries as well as all of the examples. The

test.sh

script accepts no flags or either the

--release

flag to test in release mode or the

--contrib

flag to test all

contrib

modules individually. This script gets run by CI.

To test a crate individually, run

cargo test --all-features

in the corresponding crate directory.

Core

Testing for the core library is done inline in the corresponding module. For example, the tests for routing can be found at the bottom of the

lib/src/router/mod.rs

file.

Codegen

Code generation tests can be found in

codegen/tests

. We use the compiletestlibrary, which was extracted from

rustc

, for testing. See the compiler test documentation for information on how to write compiler tests.

Documentation

You can build the Rocket API documentation locally by running

./scripts/mk-docs.sh

. The resulting documentation is what gets uploaded toapi.rocket.rs.

Contributing

Contributions are absolutely, positively welcome and encouraged! Contributions come in many forms. You could:

  1. Submit a feature request or bug report as an issue.
  2. Ask for improved documentation as an issue.
  3. Comment on issues that require feedback.
  4. Contribute code via pull requests.

We aim to keep Rocket's code quality at the highest level. This means that any code you contribute must be:

  • Commented: Public items must be commented.
  • Documented: Exposed items must have rustdoc comments with examples, if applicable.
  • Styled: Your code should be
    rustfmt
    'd when possible.
  • Simple: Your code should accomplish its task as simply and idiomatically as possible.
  • Tested: You must add (and pass) convincing tests for any functionality you add.
  • Focused: Your code should do what it's supposed to do and nothing more.

All pull requests are code reviewed and tested by the CI. Note that unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rocket by you shall be dual licensed under the MIT License and Apache License, Version 2.0, without any additional terms or conditions.

License

Rocket is licensed under either of the following, at your option:

The Rocket website source is licensed under separate terms.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.