Rocket/site
Benedikt Weber 055ad107df Allow status customization in 'Forward' outcomes.
Prior to this commit, all forward outcomes resulted in a 404. This
commit changes request and data guards so that they are able to provide
a `Status` on `Forward` outcomes. The router uses this status, if the
final outcome is to forward, to identify the catcher to invoke.

The net effect is that guards can now customize the status code of a
forward and thus the error catcher invoked if the final outcome of a
request is to forward.

Resolves #1560.
2023-04-11 12:47:20 -07:00
..
guide Allow status customization in 'Forward' outcomes. 2023-04-11 12:47:20 -07:00
news Update CHANGELOG, add news article for 0.5.0-rc.3. 2023-03-23 16:56:15 -07:00
tests New version: 0.5.0-rc.3. 2023-03-23 16:56:17 -07:00
LICENSE Add site contents, including the guide. Add license information. 2017-04-16 21:11:41 -07:00
README.md New version: 0.5.0-rc.1. 2021-06-09 09:52:37 -07:00
index.toml Update CHANGELOG, add news article for 0.5.0-rc.3. 2023-03-23 16:56:15 -07:00
overview.toml Fix spacing in 'overview' code examples. 2022-02-23 14:23:35 -08:00

README.md

Rocket Website Source

This directory contains the source files for the content on Rocket's website.

Contents

This directory contains the following:

  • index.toml - Source data for the index.
  • overview.toml - Source data for the overview page (overview/).
  • news/index.toml - Source data for the news page (news/).
  • news/*.md - News articles linked to from news/index.toml.
  • guide/*.md - Guide pages linked to from guide.md.

Cross-linking guide pages is accomplished via relative links. Outside of the index, this is: ../{page}#anchor. For instance, to link to the Quickstart > Running Examples page, use ../quickstart#running-examples.

Aliases

Aliases are shorthand URLs that start with @ (e.g, @api). They are used throughout the guide to simplify versioning URLs to Rocket's source code and the Rocket API. They are replaced at build time with a URL prefix. At present, the following aliases are available, where ${version} is Rocket's version string at the time of compilation:

For example, to link to Rocket::launch(), you might write:

Launch an instance of your application using the [`launch()`] method.

[`launch()`]: @api/rocket/struct.Rocket.html#method.launch

License

The Rocket website source is licensed under the GNU General Public License v3.0.