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

Clarify built-in request guard implementations.

This commit is contained in:
Sergio Benitez 2022-07-17 18:45:11 -07:00
parent f64029f079
commit 8e8dfc7d45
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
core/lib/src/request/from_request.rs
View File

@ -159,20 +159,21 @@ impl<S, E> IntoOutcome<S, (Status, E), ()> for Result<S, E> {
///
/// * **ContentType**
///
/// Extracts the [`ContentType`] from the incoming request. If the request
/// didn't specify a Content-Type, the request is forwarded.
/// Extracts the [`ContentType`] from the incoming request via
/// [`Request::content_type()`]. If the request didn't specify a
/// Content-Type, the request is forwarded.
///
/// * **IpAddr**
///
/// Extracts the client ip address of the incoming request as an [`IpAddr`].
/// If the client's IP address is not known, the request is forwarded.
/// Extracts the client ip address of the incoming request as an [`IpAddr`]
/// via [`Request::client_ip()`]. If the client's IP address is not known,
/// the request is forwarded.
///
/// * **SocketAddr**
///
/// Extracts the remote address of the incoming request as a [`SocketAddr`].
/// If the remote address is not known, the request is forwarded.
///
/// _This implementation always returns successfully._
/// Extracts the remote address of the incoming request as a [`SocketAddr`]
/// via [`Request::remote()`]. If the remote address is not known, the
/// request is forwarded.
///
/// * **Option&lt;T>** _where_ **T: FromRequest**
///