Struct actix_web::web::Form

pub struct Form<T>(pub T);

Form data helper (application/x-www-form-urlencoded)

Can be use to extract url-encoded data from the request body, or send url-encoded data as the response.

Extract

To extract typed information from request's body, the type T must implement the Deserialize trait from serde.

FormConfig allows to configure extraction process.

Example

use actix_web::web;
use serde_derive::Deserialize;

#[derive(Deserialize)]
struct FormData {
    username: String,
}

/// Extract form data using serde.
/// This handler get called only if content type is *x-www-form-urlencoded*
/// and content of the request could be deserialized to a `FormData` struct
fn index(form: web::Form<FormData>) -> String {
    format!("Welcome {}!", form.username)
}

Respond

The Form type also allows you to respond with well-formed url-encoded data: simply return a value of type Form where T is the type to be url-encoded. The type must implement serde::Serialize;

Example

use actix_web::*;
use serde_derive::Serialize;

#[derive(Serialize)]
struct SomeForm {
    name: String,
    age: u8
}

// Will return a 200 response with header
// `Content-Type: application/x-www-form-urlencoded`
// and body "name=actix&age=123"
fn index() -> web::Form<SomeForm> {
    web::Form(SomeForm {
        name: "actix".into(),
        age: 123
    })
}

Implementations

impl<T> Form<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

impl<T: Debug> Debug for Form<T>

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

Formats the value using the given formatter.

impl<T> Deref for Form<T>

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Form<T>

pub fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: Display> Display for Form<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Form<T>

impl<T> FromRequest for Form<T> where
    T: DeserializeOwned + 'static, 

type Config = FormConfig

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = LocalBoxFuture<'static, Result<Self, Error>>

Future that resolves to a Self

pub fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Convert request to a Self

pub fn extract(req: &HttpRequest) -> Self::Future

Convert request to a Self

pub fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl<T: Ord> Ord for Form<T>

pub fn cmp(&self, other: &Form<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Form<T>> for Form<T>

pub fn eq(&self, other: &Form<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Form<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Form<T>> for Form<T>

pub fn partial_cmp(&self, other: &Form<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Form<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Form<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Form<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Form<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Serialize> Responder for Form<T>

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Response, Error>>

The future response value.

pub fn respond_to(self, _: &HttpRequest) -> Self::Future

Convert itself to AsyncResult or Error.

pub fn with_status(self, status: StatusCode) -> CustomResponder<Self> where
    Self: Sized, 

Override a status code for a Responder.

pub fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self> where
    Self: Sized,
    HeaderName: TryFrom<K>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    V: IntoHeaderValue, 

Add header to the Responder's response.

impl<T> StructuralEq for Form<T>

impl<T> StructuralPartialEq for Form<T>