Struct actix_web::web::Form [−][src]
URL encoded payload extractor and responder.
Form
has two uses: URL encoded responses, and extracting typed data from URL request payloads.
Extractor
To extract typed data from a request body, the inner type T
must implement the
serde::Deserialize
trait.
Use FormConfig
to configure extraction process.
use actix_web::{post, web}; use serde::Deserialize; #[derive(Deserialize)] struct Info { name: String, } // This handler is only called if: // - request headers declare the content type as `application/x-www-form-urlencoded` // - request payload is deserialized into a `Info` struct from the URL encoded format #[post("/")] async fn index(form: web::Form<Info>) -> String { format!("Welcome {}!", form.name) }
Responder
The Form
type also allows you to create URL encoded responses:
simply return a value of type Formserde::Serialize
.
Responses use
use actix_web::{get, web}; use serde::Serialize; #[derive(Serialize)] struct SomeForm { name: String, age: u8 } // Response will have: // - status: 200 OK // - header: `Content-Type: application/x-www-form-urlencoded` // - body: `name=actix&age=123` #[get("/")] async fn index() -> web::Form<SomeForm> { web::Form(SomeForm { name: "actix".into(), age: 123 }) }
Implementations
impl<T> Form<T>
[src]
pub fn into_inner(self) -> T
[src]
Unwrap into inner T
value.
Trait Implementations
impl<T: Debug> Debug for Form<T>
[src]
impl<T> Deref for Form<T>
[src]
impl<T> DerefMut for Form<T>
[src]
impl<T: Display> Display for Form<T>
[src]
impl<T: Eq> Eq for Form<T>
[src]
impl<T> FromRequest for Form<T> where
T: DeserializeOwned + 'static,
[src]
T: DeserializeOwned + 'static,
See here for example of usage as an extractor.
type Config = FormConfig
Configuration for this extractor.
type Error = Error
The associated error which can be returned.
type Future = LocalBoxFuture<'static, Result<Self, Error>>
Future that resolves to a Self.
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]
fn configure<F>(f: F) -> Self::Config where
F: FnOnce(Self::Config) -> Self::Config,
[src]
F: FnOnce(Self::Config) -> Self::Config,
impl<T: Ord> Ord for Form<T>
[src]
fn cmp(&self, other: &Form<T>) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<T: PartialEq> PartialEq<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]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T: Serialize> Responder for Form<T>
[src]
See here for example of usage as a handler return type.
fn respond_to(self, _: &HttpRequest) -> HttpResponseⓘ
[src]
fn with_status(self, status: StatusCode) -> CustomResponder<Self> where
Self: Sized,
[src]
Self: Sized,
fn with_header<H>(self, header: H) -> CustomResponder<Self> where
Self: Sized,
H: IntoHeaderPair,
[src]
Self: Sized,
H: IntoHeaderPair,
impl<T> Serialize for Form<T> where
T: Serialize,
[src]
T: Serialize,
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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,