Struct Form

Source

pub struct Form<T>(pub T);

Expand description

URL encoded extractor and response.

§As extractor

If used as an extractor, Form will deserialize form data from the request, specifically:

If the request has a method of GET or HEAD, the form data will be read from the query string (same as with Query)
If the request has a different method, the form will be read from the body of the request. It must have a content-type of application/x-www-form-urlencoded for this to work. If you want to parse multipart/form-data request bodies, use Multipart instead.

This matches how HTML forms are sent by browsers by default. In both cases, the inner type T must implement 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>) {
    // ...
}

§As response

Form can also be used to encode any type that implements serde::Serialize as application/x-www-form-urlencoded

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§

Source §

impl<T> Clone for Form<T>
where T: Clone,

Source §

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

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

Source §

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

Formats the value using the given formatter. Read more

Source §

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

Source §

fn default() -> Form<T>

Returns the “default value” for a type. Read more

Source §

impl<T> Deref for Form<T>

Source §

type Target = T

The resulting type after dereferencing.

Source §

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

Dereferences the value.

Source §

impl<T> DerefMut for Form<T>

Source §

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

Mutably dereferences the value.

Source §

impl<T, S> FromRequest<S> for Form<T>
where T: DeserializeOwned, S: Send + Sync,

Source §

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.

Source §

async fn from_request( req: Request<Body>, _state: &S, ) -> Result<Form<T>, <Form<T> as FromRequest<S>>::Rejection>

Perform the extraction.

Source §

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

Source §

fn into_response(self) -> Response<Body>

Create a response.

Source §

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

Auto Trait Implementations§

§

impl<T> UnwindSafe for Form<T>
where T: UnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> FromRef<T> for T
where T: Clone,

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

Source §

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + Sync + 'static,

Source §

type Future = Ready<Response<Body>>

The type of future calling this handler returns.

Source §

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.

Source §

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a tower::Layer to the handler. Read more

Source §

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a Service by providing the state

Source §

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

Source §

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a Service and no state.

Source §

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more

Source §

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, ()>, C>

Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into<U> for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §