Struct Form

pub struct Form<T>(pub T);

URL encoded payload extractor and responder.

Form has two uses: URL encoded responses, and extracting typed data from URL request payloads.

Extractor

To extract typed data from a request body, the inner type T must implement the DeserializeOwned trait.

Use FormConfig to configure extraction options.

Examples

use actix_web::{post, web};
use serde::Deserialize;

#[derive(Deserialize)]
struct Info {
    name: String,
}

// This handler is only called if:
// - request headers declare the content type as `application/x-www-form-urlencoded`
// - request payload deserializes into an `Info` struct from the URL encoded format
#[post("/")]
async fn index(web::Form(form): web::Form<Info>) -> String {
    format!("Welcome {}!", form.name)
}

Responder

The Form type also allows you to create URL encoded responses by returning a value of type Form<T> where T is the type to be URL encoded, as long as T implements Serialize.

Examples

use actix_web::{get, web};
use serde::Serialize;

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

// Response will have:
// - status: 200 OK
// - header: `Content-Type: application/x-www-form-urlencoded`
// - body: `name=actix&age=123`
#[get("/")]
async fn index() -> web::Form<SomeForm> {
    web::Form(SomeForm {
        name: "actix".to_owned(),
        age: 123
    })
}

Panics

URL encoded forms consist of unordered key=value pairs, therefore they cannot be decoded into any type which depends upon data ordering (eg. tuples). Trying to do so will result in a panic.

Tuple Fields

0: T

Implementations

impl<T> Form<T>

pub fn into_inner(self) -> T

Unwrap into inner T value.

Trait Implementations

impl<T> Apiv2Schema for Form<T>

where T: Apiv2Schema,

fn name() -> Option<String>

Name of this schema. This is the name to which the definition of the object is mapped.

fn description() -> &'static str

Description of this schema. In case the trait is derived, uses the documentation on the type.

fn required() -> bool

Indicates the requirement of this schema.

fn raw_schema() -> DefaultSchemaRaw

Returns the raw schema for this object.

fn schema_with_ref() -> DefaultSchemaRaw

Returns the schema with a reference (if this is an object).

fn security_scheme() -> Option<SecurityScheme>

Returns the security scheme for this object.

fn header_parameter_schema() -> Vec<Parameter<DefaultSchemaRaw>>

impl<T> Debug for Form<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Form<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Form<T>

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

Mutably dereferences the value.

impl<T> Display for Form<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> FromRequest for Form<T>

where T: DeserializeOwned + 'static,

See here for example of usage as an extractor.

type Error = Error

The associated error which can be returned.

type Future = FormExtractFut<T>

Future that resolves to a Self.

fn from_request( req: &HttpRequest, payload: &mut Payload, ) -> <Form<T> as FromRequest>::Future

Create a Self from request parts asynchronously.

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

Create a Self from request head asynchronously.

impl<T> OperationModifier for Form<T>

where T: Apiv2Schema,

fn update_parameter( op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the parameters list in the given operation (if needed).

fn update_definitions(_map: &mut BTreeMap<String, DefaultSchemaRaw>)

Update the definitions map (if needed).

fn update_response( _op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the responses map in the given operation (if needed).

fn update_security( op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the security map in the given operation (if needed).

fn update_security_definitions(map: &mut BTreeMap<String, SecurityScheme>)

Update the security definition map (if needed).

impl<T> Ord for Form<T>

where T: Ord,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Form<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for Form<T>

where T: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Responder for Form<T>

where T: Serialize,

See here for example of usage as a handler return type.

type Body = EitherBody<String>

fn respond_to( self, _: &HttpRequest, ) -> HttpResponse<<Form<T> as Responder>::Body>

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

where Self: Sized,

Wraps responder to allow alteration of its response.

impl<T> Serialize for Form<T>

where T: Serialize,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for Form<T>

where T: Eq,

impl<T> StructuralPartialEq for Form<T>