Struct Form

pub struct Form<T>(pub T);

URL encoded extractor and response.

As extractor

If used as an extractor Form will deserialize the query parameters for GET and HEAD requests and application/x-www-form-urlencoded encoded request bodies for other methods. It supports any type that implements serde::Deserialize.

⚠️ Since parsing form data might require consuming the request body, the Form extractor must be last if there are multiple extractors in a handler. See “the order of extractors”

use axum::Form;
use serde::Deserialize;

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

async fn accept_form(Form(sign_up): Form<SignUp>) {
    // ...
}

Note that Content-Type: multipart/form-data requests are not supported. Use Multipart instead.

As response

use axum::Form;
use serde::Serialize;

#[derive(Serialize)]
struct Payload {
    value: String,
}

async fn handler() -> Form<Payload> {
    Form(Payload { value: "foo".to_owned() })
}

Tuple Fields

0: T

Trait Implementations

impl<T> Clone for Form<T>

where T: Clone,

fn clone(&self) -> Form<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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> Default for Form<T>

where T: Default,

fn default() -> Form<T>

Returns the “default value” for a type.

impl<T> Deref for Form<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Form<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Form<T>

fn deref_mut(&mut self) -> &mut <Form<T> as Deref>::Target

Mutably dereferences the value.

impl<T, S, B> FromRequest<S, B> for Form<T>

where T: DeserializeOwned, B: Body + Send + 'static, <B as Body>::Data: Send, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>, S: Send + Sync,

type Rejection = FormRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: Request<B>, _state: &'life0 S, ) -> Pin<Box<dyn Future<Output = Result<Form<T>, <Form<T> as FromRequest<S, B>>::Rejection>> + Send + 'async_trait>>

where 'life0: 'async_trait, Form<T>: 'async_trait,

Perform the extraction.

impl<T> IntoResponse for Form<T>

where T: Serialize,

fn into_response(self) -> Response<UnsyncBoxBody<Bytes, Error>>

Create a response.

impl<T> Copy for Form<T>

where T: Copy,