Struct ntex::web::types::Form

pub struct Form<T>(pub T);

Form data helper (application/x-www-form-urlencoded)

Can be use to extract url-encoded data from the request body, or send url-encoded data as the response.

Extract

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

use ntex::web;

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

Respond

The Form type also allows you to respond with well-formed url-encoded data: simply return a value of type Form where T is the type to be url-encoded. The type must implement serde::Serialize;

Example

use ntex::web;

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

// Will return a 200 response with header
// `Content-Type: application/x-www-form-urlencoded`
// and body "name=ntex&age=123"
fn index() -> web::types::Form<SomeForm> {
    web::types::Form(SomeForm {
        name: "ntex".into(),
        age: 123
    })
}

Tuple Fields

0: T

Implementations

impl<T> Form<T>

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations

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

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

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

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

Formats the value using the given formatter.

impl<T, Err> FromRequest<Err> for Form<T>

where T: DeserializeOwned + 'static, Err: ErrorRenderer,

type Error = UrlencodedError

The associated error which can be returned.

async fn from_request( req: &HttpRequest, payload: &mut Payload ) -> Result<Self, Self::Error>

Convert request to a Self

impl<T: Ord> Ord for Form<T>

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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Form<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for Form<T>

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Serialize, Err: ErrorRenderer> Responder<Err> for Form<T>

where Err::Container: From<Error>,

async fn respond_to(self, req: &HttpRequest) -> Response

Convert itself to http response.

fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err>

where Self: Sized,

Override a status code for a Responder.

fn with_header<K, V>(self, key: K, value: V) -> CustomResponder<Self, Err>

where Self: Sized, HeaderName: TryFrom<K>, HeaderValue: TryFrom<V>, <HeaderName as TryFrom<K>>::Error: Into<HttpError>, <HeaderValue as TryFrom<V>>::Error: Into<HttpError>,

Add header to the Responder’s response.

impl<T: Eq> Eq for Form<T>

impl<T> StructuralPartialEq for Form<T>