Expand description
Multipart request & form support for Actix Web.
The Multipart extractor aims to support all kinds of multipart/* requests, including
multipart/form-data, multipart/related and multipart/mixed. This is a lower-level
extractor which supports reading multipart fields, in the order they are sent by the
client.
Due to additional requirements for multipart/form-data requests, the higher level
MultipartForm extractor and derive macro only supports this media type.
§Examples
use actix_web::{post, App, HttpServer, Responder};
use actix_multipart::form::{json::Json as MpJson, tempfile::TempFile, MultipartForm, MultipartFormConfig};
use serde::Deserialize;
#[derive(Debug, Deserialize)]
struct Metadata {
name: String,
}
#[derive(Debug, MultipartForm)]
struct UploadForm {
// Note: the form is also subject to the global limits configured using `MultipartFormConfig`.
#[multipart(limit = "100MB")]
file: TempFile,
json: MpJson<Metadata>,
}
#[post("/videos")]
pub async fn post_video(MultipartForm(form): MultipartForm<UploadForm>) -> impl Responder {
format!(
"Uploaded file {}, with size: {}",
form.json.name, form.file.size
)
}
#[actix_web::main]
async fn main() -> std::io::Result<()> {
HttpServer::new(move || {
App::new()
.service(post_video)
// Also increase the global total limit to 100MiB.
.app_data(MultipartFormConfig::default().total_limit(100 * 1024 * 1024))
})
.bind(("127.0.0.1", 8080))?
.run()
.await
}cURL request:
curl -v --request POST \
--url http://localhost:8080/videos \
-F 'json={"name": "Cargo.lock"};type=application/json' \
-F file=@./Cargo.lockModules§
- form
- Extract and process typed data from fields of a
multipart/form-datarequest. - test
- Multipart testing utilities.
Structs§
- Field
- A single field in a multipart stream.
- Limit
Exceeded - Error type returned from
Field::bytes()when field data is larger than limit. - Multipart
- The server-side implementation of
multipart/form-datarequests. - Multipart
Config Multipartextractor configuration.
Enums§
- Multipart
Error - A set of errors that can occur during parsing multipart streams.