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

Fix parsing docs for 'Lenient'. 

Resolves #2039.
This commit is contained in:
Sergio Benitez 2022-03-09 14:09:22 -08:00
parent 4fcb57b704
commit ae0ccf43f1
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
core/lib/src/form/lenient.rs
View File

@ -8,9 +8,7 @@ use crate::http::uri::fmt::{Query, FromUriParam};
/// This type implements the [`FromForm`] trait and thus can be used as a /// This type implements the [`FromForm`] trait and thus can be used as a
/// generic parameter to the [`Form`] data guard: `Form<Lenient<T>>`, where `T` /// generic parameter to the [`Form`] data guard: `Form<Lenient<T>>`, where `T`
/// implements `FromForm`. Unlike using `Form` directly, this type uses a /// implements `FromForm`. Unlike using `Form` directly, this type uses a
/// _lenient_ parsing strategy: forms that contains a superset of the expected /// _lenient_ parsing strategy.
/// fields (i.e, extra fields) will fail to parse and defaults will not be use
/// for missing fields.
/// ///
/// # Lenient Parsing /// # Lenient Parsing
/// ///
@ -35,6 +33,8 @@ use crate::http::uri::fmt::{Query, FromUriParam};
/// ///
/// #[derive(FromForm)] /// #[derive(FromForm)]
/// struct UserInput { /// struct UserInput {
/// // Parses as `Some(false)` when `lenient_inner_option` isn't present.
/// // Without `Lenient`, this would otherwise parse as `None`.
/// lenient_inner_option: Option<Lenient<bool>>, /// lenient_inner_option: Option<Lenient<bool>>,
/// } /// }
/// ``` /// ```