# actix_web::Form - Rust
API documentation for the Rust `Form` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Form

# Struct actix_web::Form [−] [src]

    pub struct Form<T>(pub T);

Extract typed information from the request's body.

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

    #[macro_use] extern crate serde_derive;
    use actix_web::{App, Form, Result};

    #[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: Form<FormData>) -> Result<String> {
        Ok(format!("Welcome {}!", form.username))
    }

## Methods

###

`impl<T> Form<T>`

[src]

####

`pub fn into_inner(self) -> T`

[src]

Deconstruct to an inner value

## Trait Implementations

###

`impl<T> Deref for Form<T>`

[src]

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

`fn deref(&self) -> &T`

[src]

Dereferences the value.

###

`impl<T> DerefMut for Form<T>`

[src]

####
ⓘImportant traits for &'a mut R

### Important traits for &'a mut R

`impl<'a, R> Read for &'a mut R where
R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`

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

[src]

Mutably dereferences the value.

###

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

[src]

#### `type Config = FormConfig<S>`

Configuration for conversion process

#### `type Result = Box<Future<Item = Self, Error = Error>>`

Future that resolves to a Self

####

`fn from_request(req: &HttpRequest<S>, cfg: &Self::Config) -> Self::Result`

[src]

Convert request to a Self

####

`fn extract(req: &HttpRequest<S>) -> Self::Result`

[src]

Convert request to a Self Read more

###

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

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

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

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl<T> Send for Form<T> where T: Send,`

###

`impl<T> Sync for Form<T> where T: Sync,`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)