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 dfc9e9aab0
commit 53353df633
9 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/uuid.rs
View File

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -29,7 +29,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 properties. This section describes how to ask Rocket to validate against all of
these properties and more. these properties and more.
[`route`]: @api/rocket_codegen/attr.route.html [`route`]: @api/rocket/attr.route.html
## Methods ## Methods
@ -46,8 +46,7 @@ to the root path:
# fn handler() {} # fn handler() {}
``` ```
The grammar for these attributes is defined formally in the The grammar for these attributes is defined formally in the [`route`] API docs.
[`rocket_codegen`](@api/rocket_codegen/attr.route.html) API docs.
### HEAD Requests ### HEAD Requests
@ -1150,8 +1149,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 the catcher takes a parameter, it must be of type [`&Request`]. The [error
catcher example](@example/errors) on GitHub illustrates their use in full. 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 [`register()`]: @api/rocket/struct.Rocket.html#method.register
[`mount()`]: @api/rocket/struct.Rocket.html#method.mount [`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 [`&Request`]: @api/rocket/struct.Request.html

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

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