Struct ntex::web::types::Form [−][src]
pub struct Form<T>(pub T);
Expand description
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 Formserde::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
Deconstruct to an inner value
Trait Implementations
impl<T, Err> FromRequest<Err> for Form<T> where
T: DeserializeOwned + 'static,
Err: ErrorRenderer,
impl<T, Err> FromRequest<Err> for Form<T> where
T: DeserializeOwned + 'static,
Err: ErrorRenderer,
type Error = UrlencodedError
type Error = UrlencodedError
The associated error which can be returned.
Future that resolves to a Self
Convert request to a Self
Convert request to a Self Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Convert itself to AsyncResult
or Error
.
Override a status code for a Responder. Read more
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>,
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. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for Form<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Form<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more