Overhaul URI types.
This is fairly large commit with several entangled logical changes.
The primary change in this commit is to completely overhaul how URI
handling in Rocket works. Prior to this commit, the `Uri` type acted as
an origin API. Its parser was minimal and lenient, allowing URIs that
were invalid according to RFC 7230. By contrast, the new `Uri` type
brings with it a strict RFC 7230 compliant parser. The `Uri` type now
represents any kind of valid URI, not simply `Origin` types. Three new
URI types were introduced:
* `Origin` - represents valid origin URIs
* `Absolute` - represents valid absolute URIs
* `Authority` - represents valid authority URIs
The `Origin` type replaces `Uri` in many cases:
* As fields and method inputs of `Route`
* The `&Uri` request guard is now `&Origin`
* The `uri!` macro produces an `Origin` instead of a `Uri`
The strict nature of URI parsing cascaded into the following changes:
* Several `Route` methods now `panic!` on invalid URIs
* The `Rocket::mount()` method is (correctly) stricter with URIs
* The `Redirect` constructors take a `TryInto<Uri>` type
* Dispatching of a `LocalRequest` correctly validates URIs
Overall, URIs are now properly and uniformly handled throughout Rocket's
codebase, resulting in a more reliable and correct system.
In addition to these URI changes, the following changes are also part of
this commit:
* The `LocalRequest::cloned_dispatch()` method was removed in favor of
chaining `.clone().dispatch()`.
* The entire Rocket codebase uses `crate` instead of `pub(crate)` as a
visibility modifier.
* Rocket uses the `crate_visibility_modifier` and `try_from` features.
A note on unsafety: this commit introduces many uses of `unsafe` in the
URI parser. All of these uses are a result of unsafely transforming byte
slices (`&[u8]` or similar) into strings (`&str`). The parser ensures
that these casts are safe, but of course, we must label their use
`unsafe`. The parser was written to be as generic and efficient as
possible and thus can parse directly from byte sources. Rocket, however,
does not make use of this fact and so would be able to remove all uses
of `unsafe` by parsing from an existing `&str`. This should be
considered in the future.
Fixes #443.
Resolves #263.
2018-07-29 01:26:15 +00:00
|
|
|
#![feature(crate_visibility_modifier)]
|
2018-07-21 22:11:08 +00:00
|
|
|
#![feature(never_type)]
|
2018-08-18 23:52:45 +00:00
|
|
|
#![feature(doc_cfg)]
|
2017-01-12 10:52:23 +00:00
|
|
|
|
2018-10-27 04:20:12 +00:00
|
|
|
#![doc(html_root_url = "https://api.rocket.rs/v0.4")]
|
|
|
|
|
#![doc(html_favicon_url = "https://rocket.rs/v0.4/images/favicon.ico")]
|
|
|
|
|
#![doc(html_logo_url = "https://rocket.rs/v0.4/images/logo-boxed.png")]
|
2017-06-11 08:03:59 +00:00
|
|
|
|
2016-09-19 23:24:01 +00:00
|
|
|
//! This crate contains officially sanctioned contributor libraries that provide
|
|
|
|
|
//! functionality commonly used by Rocket applications.
|
|
|
|
|
//!
|
|
|
|
|
//! These libraries are always kept in-sync with the core Rocket library. They
|
|
|
|
|
//! provide common, but not fundamental, abstractions to be used by Rocket
|
2018-10-06 13:25:17 +00:00
|
|
|
//! applications.
|
2016-09-19 23:24:01 +00:00
|
|
|
//!
|
|
|
|
|
//! Each module in this library is held behind a feature flag, with the most
|
|
|
|
|
//! common modules exposed by default. The present feature list is below, with
|
|
|
|
|
//! an asterisk next to the features that are enabled by default:
|
|
|
|
|
//!
|
2018-10-07 00:24:11 +00:00
|
|
|
//! * [json*](type@json) - JSON (de)serialization
|
|
|
|
|
//! * [serve*](serve) - Static File Serving
|
|
|
|
|
//! * [msgpack](msgpack) - MessagePack (de)serialization
|
|
|
|
|
//! * [handlebars_templates](templates) - Handlebars Templating
|
|
|
|
|
//! * [tera_templates](templates) - Tera Templating
|
|
|
|
|
//! * [uuid](uuid) - UUID (de)serialization
|
|
|
|
|
//! * [${database}_pool](databases) - Database Configuration and Pooling
|
2018-11-08 17:01:58 +00:00
|
|
|
//! * [helmet](helmet) - Fairing for Security and Privacy Headers
|
2016-09-19 23:24:01 +00:00
|
|
|
//!
|
|
|
|
|
//! The recommend way to include features from this crate via Cargo in your
|
|
|
|
|
//! project is by adding a `[dependencies.rocket_contrib]` section to your
|
|
|
|
|
//! `Cargo.toml` file, setting `default-features` to false, and specifying
|
|
|
|
|
//! features manually. For example, to use the JSON module, you would add:
|
|
|
|
|
//!
|
2018-10-06 13:25:17 +00:00
|
|
|
//! ```toml
|
2016-09-19 23:24:01 +00:00
|
|
|
//! [dependencies.rocket_contrib]
|
2018-12-01 04:21:51 +00:00
|
|
|
//! version = "0.4.0-rc.2"
|
2016-09-19 23:24:01 +00:00
|
|
|
//! default-features = false
|
|
|
|
|
//! features = ["json"]
|
|
|
|
|
//! ```
|
|
|
|
|
//!
|
|
|
|
|
//! This crate is expected to grow with time, bringing in outside crates to be
|
|
|
|
|
//! officially supported by Rocket.
|
|
|
|
|
|
2018-09-20 04:14:30 +00:00
|
|
|
#[allow(unused_imports)] #[macro_use] extern crate log;
|
|
|
|
|
#[allow(unused_imports)] #[macro_use] extern crate rocket;
|
2016-09-19 23:24:01 +00:00
|
|
|
|
2018-10-07 00:24:11 +00:00
|
|
|
#[cfg(feature="json")] #[macro_use] pub mod json;
|
|
|
|
|
#[cfg(feature="serve")] pub mod serve;
|
|
|
|
|
#[cfg(feature="msgpack")] pub mod msgpack;
|
|
|
|
|
#[cfg(feature="templates")] pub mod templates;
|
|
|
|
|
#[cfg(feature="uuid")] pub mod uuid;
|
|
|
|
|
#[cfg(feature="databases")] pub mod databases;
|
2018-11-08 17:01:58 +00:00
|
|
|
#[cfg(feature = "helmet")] pub mod helmet;
|
2017-02-01 01:15:42 +00:00
|
|
|
|
2018-10-09 11:16:57 +00:00
|
|
|
#[cfg(feature="databases")] extern crate rocket_contrib_codegen;
|
|
|
|
|
#[cfg(feature="databases")] #[doc(hidden)] pub use rocket_contrib_codegen::*;
|
