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

Fix more broken links.

This commit is contained in:
Sergio Benitez 2020-03-09 01:58:20 -07:00
parent cba00ec66a
commit 635a4bddba
10 changed files with 43 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contrib/lib/src/msgpack.rs
View File

@ -1,6 +1,6 @@
//! Automatic MessagePack (de)serialization support.
//!
//! See the [`MsgPack`](msgpack::MessagePack) type for further details.
//! See the [`MsgPack`] type for further details.
//!
//! # Enabling
//!

2
contrib/lib/src/uuid.rs
View File

@ -1,6 +1,6 @@
//! UUID parameter and form value parsing support.
//!
//! See the [`Uuid`](uuid::Uuid) type for further details.
//! See the [`Uuid`] type for further details.
//!
//! # Enabling
//!

36
core/codegen/src/lib.rs
View File

@ -161,16 +161,16 @@ macro_rules! route_attribute {
///
/// There are 7 method-specific route attributes:
///
/// * [`#[get]`] - `GET` specific route
/// * [`#[put]`] - `PUT` specific route
/// * [`#[post]`] - `POST` specific route
/// * [`#[delete]`] - `DELETE` specific route
/// * [`#[head]`] - `HEAD` specific route
/// * [`#[options]`] - `OPTIONS` specific route
/// * [`#[patch]`] - `PATCH` specific route
/// * [`get`] - `GET` specific route
/// * [`put`] - `PUT` specific route
/// * [`post`] - `POST` specific route
/// * [`delete`] - `DELETE` specific route
/// * [`head`] - `HEAD` specific route
/// * [`options`] - `OPTIONS` specific route
/// * [`patch`] - `PATCH` specific route
///
/// Additionally, [`#[route]`] allows the method and path to be
/// explicitly specified:
/// Additionally, [`route`] allows the method and path to be explicitly
/// specified:
///
/// ```rust
/// # #![feature(proc_macro_hygiene, decl_macro)]
@ -182,14 +182,14 @@ macro_rules! route_attribute {
/// }
/// ```
///
/// [`#[delete]`]: attr.delete.html
/// [`#[get]`]: attr.get.html
/// [`#[head]`]: attr.head.html
/// [`#[options]`]: attr.options.html
/// [`#[patch]`]: attr.patch.html
/// [`#[post]`]: attr.post.html
/// [`#[put]`]: attr.put.html
/// [`#[route]`]: attr.route.html
/// [`get`]: attr.get.html
/// [`put`]: attr.put.html
/// [`post`]: attr.post.html
/// [`delete`]: attr.delete.html
/// [`head`]: attr.head.html
/// [`options`]: attr.options.html
/// [`patch`]: attr.patch.html
/// [`route`]: attr.route.html
///
/// # Grammar
///
@ -267,7 +267,7 @@ macro_rules! route_attribute {
///
/// [`FromParam`]: ../rocket/request/trait.FromParam.html
/// [`FromSegments`]: ../rocket/request/trait.FromSegments.html
/// [`FromFormValue`]: ../rocket/request/form/trait.FromFormValue.html
/// [`FromFormValue`]: ../rocket/request/trait.FromFormValue.html
/// [`FromQuery`]: ../rocket/request/trait.FromQuery.html
/// [`FromData`]: ../rocket/data/trait.FromData.html
/// [`FromRequest`]: ../rocket/request/trait.FromRequest.html

2
core/http/src/uri/from_uri_param.rs
View File

@ -187,7 +187,7 @@ use uri::{self, UriPart, UriDisplay};
/// assert_eq!(uri.query(), Some("name=Robert%20Mike&nickname=Bob"));
/// ```
///
/// [`uri!`]: ::rocket_codegen::uri
/// [`uri!`]: ::rocket::uri
/// [`UriDisplay`]: uri::UriDisplay
/// [`FromUriParam::Target`]: uri::FromUriParam::Target
/// [`Path`]: uri::Path

10
core/http/src/uri/uri_display.rs
View File

@ -106,7 +106,7 @@ use uri::{Uri, UriPart, Path, Query, Formatter};
/// seen, the implementations will be used to display the value in a URI-safe
/// manner.
///
/// [`uri!`]: ../../../rocket_codegen/macro.uri.html
/// [`uri!`]: ../../../rocket/macro.uri.html
///
/// # Provided Implementations
///
@ -201,11 +201,13 @@ use uri::{Uri, UriPart, Path, Query, Formatter};
/// As long as every field in the structure (or enum) implements `UriDisplay`,
/// the trait can be derived. The implementation calls
/// [`Formatter::write_named_value()`] for every named field and
/// [`Formatter::write_value()`] for every unnamed field. See the [`UriDisplay`
/// derive] documentation for full details.
/// [`Formatter::write_value()`] for every unnamed field. See the
/// [`UriDisplay<Path>`] and [`UriDisplay<Query>`] derive documentation for full
/// details.
///
/// [`Ignorable`]: uri::Ignorable
/// [`UriDisplay` derive]: ../../../rocket_codegen/derive.UriDisplay.html
/// [`UriDisplay<Path>`]: ../../derive.UriDisplayPath.html
/// [`UriDisplay<Query>`]: ../../derive.UriDisplayQuery.html
/// [`Formatter::write_named_value()`]: uri::Formatter::write_named_value()
/// [`Formatter::write_value()`]: uri::Formatter::write_value()
///

2
core/lib/src/request/form/form_items.rs
View File

@ -39,7 +39,7 @@ use http::RawStr;
///
/// This iterator returns values of the type [`FormItem`]. To access the
/// associated key/value pairs of the form item, either directly access them via
/// the [`key`](FormItem.key) and [`value`](FormItem.value) fields, use the
/// the [`key`](FormItem::key) and [`value`](FormItem::value) fields, use the
/// [`FormItem::key_value()`] method to get a tuple of the _raw_ `(key, value)`,
/// or use the [`key_value_decoded()`](FormItem::key_value_decoded()) method to
/// get a tuple of the decoded (`key`, `value`).

9
core/lib/src/response/mod.rs
View File

@ -16,9 +16,12 @@
//!
//! # Contrib
//!
//! The [`contrib` crate](rocket_contrib) contains several useful `Responder`s
//! including [`Template`](rocket_contrib::templates::Template) and
//! [`Json`](rocket_contrib::json::Json).
//! The [`contrib` crate] contains several useful `Responder`s including
//! [`Template`] and [`Json`].
//!
//! [`contrib` crate]: ../../rocket_contrib
//! [`Template`]: ../../rocket_contrib/templates/struct.Template.html
//! [`Json`]: ../../rocket_contrib/json/struct.Json.html
mod responder;
mod redirect;

2
core/lib/src/response/redirect.rs
View File

@ -42,7 +42,7 @@ use http::Status;
/// ```
///
/// [`Origin`]: ::http::uri::Origin
/// [`uri!`]: ../../rocket_codegen/macro.uri.html
/// [`uri!`]: ../../rocket/macro.uri.html
#[derive(Debug)]
pub struct Redirect(Status, Option<Uri<'static>>);

9
site/guide/4-requests.md
View File

@ -30,7 +30,7 @@ validations. Rocket's code generation takes care of actually validating the
properties. This section describes how to ask Rocket to validate against all of
these properties and more.
[`route`]: @api/rocket_codegen/attr.route.html
[`route`]: @api/rocket/attr.route.html
## Methods
@ -48,8 +48,7 @@ to the root path:
# fn handler() {}
```
The grammar for these attributes is defined formally in the
[`rocket_codegen`](@api/rocket_codegen/attr.route.html) API docs.
The grammar for these attributes is defined formally in the [`route`] API docs.
### HEAD Requests
@ -1176,8 +1175,8 @@ Unlike route request handlers, catchers take exactly zero or one parameter. If
the catcher takes a parameter, it must be of type [`&Request`]. The [error
catcher example](@example/errors) on GitHub illustrates their use in full.
[`catch`]: @api/rocket_codegen/attr.catch.html
[`catch`]: @api/rocket/attr.catch.html
[`register()`]: @api/rocket/struct.Rocket.html#method.register
[`mount()`]: @api/rocket/struct.Rocket.html#method.mount
[`catchers!`]: @api/rocket_codegen/macro.catchers.html
[`catchers!`]: @api/rocket/macro.catchers.html
[`&Request`]: @api/rocket/struct.Request.html

8
site/guide/5-responses.md
View File

@ -163,7 +163,7 @@ simply including fields of these types.
For more on using the `Responder` derive, see the [`Responder` derive]
documentation.
[`Responder` derive]: @api/rocket_codegen/derive.Responder.html
[`Responder` derive]: @api/rocket/derive.Responder.html
## Implementations
@ -657,11 +657,11 @@ See the [`FromUriParam`] documentation for further details.
[`UriPart`]: @api/rocket/http/uri/trait.UriPart.html
[`Uri`]: @api/rocket/http/uri/enum.Uri.html
[`Redirect::to()`]: @api/rocket/response/struct.Redirect.html#method.to
[`uri!`]: @api/rocket_codegen/macro.uri.html
[`uri!`]: @api/rocket/macro.uri.html
[`UriDisplay`]: @api/rocket/http/uri/trait.UriDisplay.html
[`FromUriParam`]: @api/rocket/http/uri/trait.FromUriParam.html
[`Path`]: @api/rocket/http/uri/enum.Path.html
[`Query`]: @api/rocket/http/uri/enum.Query.html
[`Ignorable`]: @api/rocket/http/uri/trait.Ignorable.html
[`UriDisplayPath`]: @api/rocket_codegen/derive.UriDisplayPath.html
[`UriDisplayQuery`]: @api/rocket_codegen/derive.UriDisplayQuery.html
[`UriDisplayPath`]: @api/rocket/derive.UriDisplayPath.html
[`UriDisplayQuery`]: @api/rocket/derive.UriDisplayQuery.html