Type Alias FormError

pub type FormError<'f> = FormDataError<'f, FormParseError<'f>>;

Alias to the type of form errors returned by the FromData implementations of Form<T> where the FromForm implementation for T was derived.

This alias is particularly useful when “catching” form errors in routes.

Example

use rocket::request::{Form, FormError, FormDataError};

#[derive(FromForm)]
struct Input {
    value: String,
}

#[post("/", data = "<sink>")]
fn submit(sink: Result<Form<Input>, FormError>) -> String {
    match sink {
        Ok(form) => form.into_inner().value,
        Err(FormDataError::Io(_)) => "I/O error".into(),
        Err(FormDataError::Malformed(f)) | Err(FormDataError::Parse(_, f)) => {
            format!("invalid form input: {}", f)
        }
    }
}

Aliased Type

enum FormError<'f> {
    Io(Error),
    Malformed(&'f str),
    Parse(FormParseError<'f>, &'f str),
}

Variants

Io(Error)

An I/O error occurred while reading reading the data stream. This can also mean that the form contained invalid UTF-8.

Malformed(&'f str)

The form string (in .0) is malformed and was unable to be parsed as HTTP application/x-www-form-urlencoded data.

Parse(FormParseError<'f>, &'f str)

The form string (in .1) failed to parse as the intended structure. The error type in .0 contains further details.