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 }) }
Implementations
impl<T> Form<T>
[src]
impl<T> Form<T>
[src]pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
[src]Deconstruct to an inner value
Trait Implementations
impl<T, Err> FromRequest<Err> for Form<T> where
T: DeserializeOwned + 'static,
Err: ErrorRenderer,
[src]
impl<T, Err> FromRequest<Err> for Form<T> where
T: DeserializeOwned + 'static,
Err: ErrorRenderer,
[src]type Error = UrlencodedError
type Error = UrlencodedError
The associated error which can be returned.
type Future = Pin<Box<dyn Future<Output = Result<Self, Self::Error>>>>
type Future = Pin<Box<dyn Future<Output = Result<Self, Self::Error>>>>
Future that resolves to a Self
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
[src]
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
[src]Convert request to a Self
fn extract(req: &HttpRequest) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]Convert request to a Self Read more
impl<T: Ord> Ord for Form<T>
[src]
impl<T: Ord> Ord for Form<T>
[src]impl<T: PartialOrd> PartialOrd<Form<T>> for Form<T>
[src]
impl<T: PartialOrd> PartialOrd<Form<T>> for Form<T>
[src]fn partial_cmp(&self, other: &Form<T>) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Form<T>) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<T: Serialize, Err: ErrorRenderer> Responder<Err> for Form<T> where
Err::Container: From<Error>,
[src]
impl<T: Serialize, Err: ErrorRenderer> Responder<Err> for Form<T> where
Err::Container: From<Error>,
[src]fn respond_to(self, req: &HttpRequest) -> Self::Future
[src]
fn respond_to(self, req: &HttpRequest) -> Self::Future
[src]Convert itself to AsyncResult
or Error
.
fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err> where
Self: Sized,
[src]
fn with_status(self, status: StatusCode) -> CustomResponder<Self, Err> where
Self: Sized,
[src]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>,
[src]
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>,
[src]Add header to the Responder’s response. Read more
impl<T: Eq> Eq for Form<T>
[src]
impl<T> StructuralEq for Form<T>
[src]
impl<T> StructuralPartialEq for Form<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Form<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Form<T> where
T: Send,
T: Send,
impl<T> Sync for Form<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Form<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Form<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self