Struct MultipartForm 

pub struct MultipartForm<T: MultipartCollect>(pub T);

Typed multipart/form-data extractor.

To extract typed data from a multipart stream, the inner type T must implement the MultipartCollect trait. You should use the MultipartForm macro to derive this for your struct.

Note that this extractor rejects requests with any other Content-Type such as multipart/mixed, multipart/related, or non-multipart media types.

Add a MultipartFormConfig to your app data to configure extraction.

Basic Use

Each field type should implement the FieldReader trait:

use actix_multipart::form::{tempfile::TempFile, text::Text, MultipartForm};

#[derive(MultipartForm)]
struct ImageUpload {
    description: Text<String>,
    timestamp: Text<i64>,
    image: TempFile,
}

Optional and List Fields

You can also use Vec<T> and Option<T> provided that T: FieldReader.

A Vec field corresponds to an upload with multiple parts under the same field name.

use actix_multipart::form::{tempfile::TempFile, text::Text, MultipartForm};

#[derive(MultipartForm)]
struct Form {
    category: Option<Text<String>>,
    files: Vec<TempFile>,
}

Field Renaming

You can use the #[multipart(rename = "foo")] attribute to receive a field by a different name.

use actix_multipart::form::{tempfile::TempFile, MultipartForm};

#[derive(MultipartForm)]
struct Form {
    #[multipart(rename = "files[]")]
    files: Vec<TempFile>,
}

Field Limits

You can use the #[multipart(limit = "<size>")] attribute to set field level limits. The limit string is parsed using bytesize.

Note: the form is also subject to the global limits configured using MultipartFormConfig.

use actix_multipart::form::{tempfile::TempFile, text::Text, MultipartForm};

#[derive(MultipartForm)]
struct Form {
    #[multipart(limit = "2 KiB")]
    description: Text<String>,

    #[multipart(limit = "512 MiB")]
    files: Vec<TempFile>,
}

Unknown Fields

By default fields with an unknown name are ignored. They can be rejected using the #[multipart(deny_unknown_fields)] attribute:

use actix_multipart::form::MultipartForm;

#[derive(MultipartForm)]
#[multipart(deny_unknown_fields)]
struct Form {}

Duplicate Fields

The behaviour for when multiple fields with the same name are received can be changed using the #[multipart(duplicate_field = "<behavior>")] attribute:

• “ignore”: (default) Extra fields are ignored. I.e., the first one is persisted.
• “deny”: A MultipartError::DuplicateField error response is returned.
• “replace”: Each field is processed, but only the last one is persisted.

Note that Vec fields will ignore this option.

use actix_multipart::form::MultipartForm;

#[derive(MultipartForm)]
#[multipart(duplicate_field = "deny")]
struct Form {}

Tuple Fields

0: T

Implementations

impl<T: MultipartCollect> MultipartForm<T>

pub fn into_inner(self) -> T

Unwrap into inner T value.

Trait Implementations

impl<T: MultipartCollect> Deref for MultipartForm<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: MultipartCollect> DerefMut for MultipartForm<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> FromRequest for MultipartForm<T>

where T: MultipartCollect + 'static,

type Error = Error

The associated error which can be returned.

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

Future that resolves to a Self.

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

Create a Self from request parts asynchronously.

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

Create a Self from request head asynchronously.