Skip to main content

FormErrors

Struct FormErrors 

Source
pub struct FormErrors(/* private fields */);
Available on crate feature alloc only.
Expand description

Every problem with one submitted form, for showing the form again with a message beside each field: what FromForm::from_body_all returns.

A parse error (a malformed body, a limit) stops the parse, so it is the only error; extraction errors are collected for every field, at most one per received value plus one per missing field. No value is ever kept.

§Examples

use form_net::{ExtractError, FromForm};

form_net::form! {
    #[derive(Debug)]
    pub struct Signup { pub email: String, pub age: u8, pub tos: bool }
}

let errors = Signup::from_body_all(b"application/x-www-form-urlencoded", b"age=300&role=admin").unwrap_err();
assert_eq!(errors.len(), 3);
assert_eq!(errors.field("age"), Some(ExtractError::Invalid("out of range")));
assert_eq!(errors.field("email"), Some(ExtractError::Missing));
assert_eq!(errors.unknown(), 1);
assert_eq!(errors.status_hint(), 422);

Implementations§

Source§

impl FormErrors

Source

pub fn iter(&self) -> impl Iterator<Item = &FormError>

Every error, in the order found.

Source

pub fn len(&self) -> usize

How many errors.

Source

pub fn is_empty(&self) -> bool

Whether there are none (never true for a returned value).

Source

pub fn first(&self) -> Option<&FormError>

The first error.

Source

pub fn field(&self, name: &str) -> Option<ExtractError>

The first extraction error for the field with this Rust name.

Source

pub fn unknown(&self) -> usize

How many received names the struct neither declares nor ignores.

Source

pub fn status_hint(&self) -> u16

The status hint of the first error (422 for extraction errors).

Trait Implementations§

Source§

impl Clone for FormErrors

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FormErrors

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for FormErrors

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for FormErrors

Source§

impl Error for FormErrors

Available on crate feature std only.
1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<FormError> for FormErrors

Source§

fn from(e: FormError) -> FormErrors

Converts to this type from the input type.
Source§

impl PartialEq for FormErrors

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FormErrors

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.