rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update outline for latest API changes.

This commit is contained in:
Sergio Benitez 2016-10-12 19:41:30 -07:00
parent b4305cb430
commit aa2f2061ac
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/outline.md
View File

@ -7,11 +7,11 @@
* **Philosophy** - The ideas behind Rocket.
* **Outline** - An outline of the guide.
**Quickstart**: Super quick info about running the examples.
**Quickstart**: Super quick info cloning the repo and running the examples.
**Getting Started**: Overview of how to use Rocket with Rust.
* **Rust Nightly** - How to get Rust nightly, and why Rocket needs it.
* **Rust Nightly** - How to get Rust nightly and why Rocket needs it.
* **Cargo Project** - How to use Rocket in a Cargo project.
* **Project Organization** - Overview of the three crates: lib, codegen, contrib.
* **Running** - Running a Rocket application and what to expect.
@ -29,21 +29,20 @@
**Routing**: How to route in Rocket.
* **Overview** - An overview of routes in Rocket.
* **Route Attribute** - Description, explanation, and how to use the attribute.
* **Route Attributes** - Description, explanation, and how to use the attribute.
* **Path** - Explanation of the path argument.
* **Static Parameters** - Static segments in route path.
* **Dynamic Parameters** - Dynamic segments in route path.
* **Segment Parameters** - Segment.. segments in route path.
* **Query Params** - Segment.. segments in route path.
* **Query Params** - Query parameter in route path.
* **Format** - Explanation of the format attribute.
* **Form** - Exaplanation of the form attribute.
* **Handlers** - How to declare handlers in Rocket.
* **Path Arguments** - Parameters declared in the route path.
* **Data** - Exaplanation of the data attribute.
* **FromRequest Arguments** - Parameters derived from the request.
* **Form Arguments** - Parameters derived from a form.
* **Mounting** - Mounting routes at a given path.
* **Collision and Ranking** - Explains route collisions and ranking.
* **Route Outcome** - Different types of outcomes and their meaning.
* **Collisions and Ranking** - Explains route collisions and ranking.
* **Responses** - Different types of outcomes and their meaning.
* **Complete** - What it means for a request to complete.
* **Forward** - What it means for a request to forward.
* **Catching Errors** - Explanation of catchers and their use.
* **Manual Routing** - How to route without using code generation.
@ -54,22 +53,31 @@
* **FromParam** - Explanation of the FromParam trait.
* **FromSegments** - Explanation of the FromSegments trait.
* **FromRequest** - Explanation of the FromRequest trait.
* **FromData** - Explanation of the FromParam trait.
* **FromForm** - Explanation of the FromForm trait.
* **FromFormValue** - Explanation of the FromFormValue trait.
* **Data** - How Rocket makes handling streaming data easy.
* **JSON** - Taking in JSON.
* **Forms** - Handling url-encoded forms. Details in next section.
* **Forms** - How Rocket makes forms easy.
* **Custom Validation** - How to add custom validation to forms.
* **Query Params** - How to use/validate query params.
* **Cookies** - Using cookies.
* **Flash** - Using flash cookies.
* **Session** - Using sessions with a private key.
* **JSON** - Taking in JSON.
**Response**
* **Overview** - An overview of the section.
* **Responder Trait** - Explanation of the Responder trait and its instability.
* **Outcomes** - Different types of responder outcomes.
* **Success** - What it means for a responder to succeed.
* **Failure** - What it means for a responder to fail.k
* **Forward** - What it means for a responder to forward.
* **Simple Responses** - The simple response types Rocket provides.
* Empty, Redirect, StatusResponse, Data
* **JSON** - Explanation and use of the JSON response.
* **Templating** - Templates in contrib.
* **Flash** - Explanation and use of the Flash response.
* Redirect, StatusResponse, Failure, Content
* **NamedFile** - Explanation and use of the NamedFile responder.
* **Stream** - Explanation and use of the Stream response.
* **Flash** - Explanation and use of the Flash response.
* **JSON** - Explanation and use of the JSON responder.
* **Templating** - Templates in contrib.