fa3e0334c1
This commit entirely rewrites Rocket's URI parsing routines and overhauls the 'uri!' macro resolving all known issues and removing any potential limitations for compile-time URI creation. This commit: * Introduces a new 'Reference' URI variant for URI-references. * Modifies 'Redirect' to accept 'TryFrom<Reference>'. * Introduces a new 'Asterisk' URI variant for parity. * Allows creation of any URI type from a string literal via 'uri!'. * Enables dynamic/static prefixing/suffixing of route URIs in 'uri!'. * Unifies 'Segments' and 'QuerySegments' into one generic 'Segments'. * Consolidates URI formatting types/traits into a 'uri::fmt' module. * Makes APIs more symmetric across URI types. It also includes the following less-relevant changes: * Implements 'FromParam' for a single-segment 'PathBuf'. * Adds 'FileName::is_safe()'. * No longer reparses upstream request URIs. Resolves #842. Resolves #853. Resolves #998. |
||
---|---|---|
.. | ||
guide | ||
news | ||
tests | ||
index.toml | ||
LICENSE | ||
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.