Struct axum::Form

pub struct Form<T>(pub T);

Available on crate feature form only.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Form<T>

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) -> &Self::Target

Dereferences the value.

impl<T, S, B> FromRequest<S, B, ViaRequest> for Form<T>where T: DeserializeOwned, B: HttpBody + Send + 'static, B::Data: Send, B::Error: Into<BoxError>, 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<Self, Self::Rejection>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl<T> IntoResponse for Form<T>where T: Serialize,

fn into_response(self) -> Response

Create a response.

impl<T: Copy> Copy for Form<T>