78e2f8a3c9
This commit completely revamps the way that codegen handles route URI "parameters". The changes are largely internal. In summary, codegen code is better organized, better written, and less subject to error. There are three breaking changes: * `path` is now `uri` in `route` attribute: `#[route(GET, path = "..")]` becomes `#[route(GET, uri = "..")]`. * the order of execution for path and query guards relative to each-other is now unspecified * URI normalization now normalizes the query part as well. Several error messages were improved. A couple of bugs were fixed: * Prior to this commit, Rocket would optimistically try to parse every segment of a URI as an ident, in case one was needed in the future. A bug in rustc results in codegen "panicking" if the segment couldn't _lex_ as an ident. This panic didn't manifest until far after expansion, unfortunately. This wasn't a problem before as we only allowed ident-like segments (ASCII), but now that we allow any UTF-8, the bug surfaced. This was fixed by never attempting to parse non-idents as idents. * Prior to this commit, it was impossible to generate typed URIs for paths that ignored path parameters via the recently added syntax `<_>`: the macro would panic. This was fixed by, well, handling these ignored parameters. Some minor additions: * Added `RawStr::find()`, expanding its `Pattern`-based API. * Added an internal mechanism to dynamically determine if a `UriPart` is `Path` or `Query`. |
||
---|---|---|
.. | ||
guide | ||
news | ||
tests | ||
LICENSE | ||
README.md | ||
index.toml | ||
overview.toml |
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 fromnews/index.toml
.guide/*.md
- Guide pages linked to fromguide.md
.
Guide Links
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:
@example
: https://github.com/SergioBenitez/Rocket/tree/${version}/examples@github
: https://github.com/SergioBenitez/Rocket/tree/${version}@api
: https://api.rocket.rs/${version}
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.