Struct Form

Source
pub struct Form<T>(pub T);
Expand description

Form can be used for extracting typed information and validation from request’s form data.

To extract and typed information from request’s form data, the type T must implement the Deserialize trait from serde and Validate trait from validator crate.

FormConfig allows to configure extraction process.

§Example

use actix_web::{web, App};
use actix_web_validator::Form;
use serde::Deserialize;
use validator::Validate;

#[derive(Deserialize, Validate)]
struct Info {
    #[validate(length(min = 3))]
    username: String,
}

/// deserialize `Info` from request's form data
async fn index(info: Form<Info>) -> String {
    format!("Welcome {}!", info.username)
}

fn main() {
    let app = App::new().service(
       web::resource("/index.html").route(
           web::post().to(index))
    );
}

Tuple Fields§

§0: T

Implementations§

Source§

impl<T> Form<T>

Source

pub fn into_inner(self) -> T

Deconstruct to an inner value

Trait Implementations§

Source§

impl<T> AsRef<T> for Form<T>

Source§

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Deref for Form<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T> FromRequest for Form<T>
where T: DeserializeOwned + Validate + 'static,

Form data helper (application/x-www-form-urlencoded). Allow to extract typed information from request’s payload and validate it.

To extract typed information from request’s body, the type T must implement the Deserialize trait from serde.

To validate payload, the type T must implement the Validate trait from validator crate.

FormConfig allows to configure extraction process.

§Example
use actix_web::{web, App};
use actix_web_validator::Form;
use serde::Deserialize;
use validator::Validate;

#[derive(Deserialize, Validate)]
struct Info {
    #[validate(length(min = 3))]
    username: String,
}

/// deserialize `Info` from request's form data
async fn index(info: Form<Info>) -> String {
    format!("Welcome {}!", info.username)
}
Source§

type Error = Error

The associated error which can be returned.
Source§

type Future = Pin<Box<dyn Future<Output = Result<Form<T>, <Form<T> as FromRequest>::Error>>>>

Future that resolves to a Self. Read more
Source§

fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.
Source§

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,