mirror of https://github.com/fafhrd91/actix-web
88 lines
3.0 KiB
Markdown
88 lines
3.0 KiB
Markdown
# `actix-multipart`
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
[](https://crates.io/crates/actix-multipart)
|
|
[](https://docs.rs/actix-multipart/0.7.2)
|
|
|
|
|
|
<br />
|
|
[](https://deps.rs/crate/actix-multipart/0.7.2)
|
|
[](https://crates.io/crates/actix-multipart)
|
|
[](https://discord.gg/NWpN5mmg3x)
|
|
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- cargo-rdme start -->
|
|
|
|
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](Field), 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
|
|
|
|
```rust
|
|
use actix_multipart::form::{
|
|
json::Json as MpJson, tempfile::TempFile, MultipartForm, MultipartFormConfig,
|
|
};
|
|
use actix_web::{middleware::Logger, post, App, HttpServer, Responder};
|
|
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")]
|
|
async fn post_video(MultipartForm(form): MultipartForm<UploadForm>) -> impl Responder {
|
|
format!(
|
|
"Uploaded file {}, with size: {}\ntemporary file ({}) was deleted\n",
|
|
form.json.name,
|
|
form.file.size,
|
|
form.file.file.path().display(),
|
|
)
|
|
}
|
|
|
|
#[actix_web::main]
|
|
async fn main() -> std::io::Result<()> {
|
|
env_logger::init_from_env(env_logger::Env::new().default_filter_or("info"));
|
|
|
|
HttpServer::new(move || {
|
|
App::new()
|
|
.service(post_video)
|
|
.wrap(Logger::default())
|
|
// Also increase the global total limit to 100MiB.
|
|
.app_data(MultipartFormConfig::default().total_limit(100 * 1024 * 1024))
|
|
})
|
|
.workers(2)
|
|
.bind(("127.0.0.1", 8080))?
|
|
.run()
|
|
.await
|
|
}
|
|
```
|
|
|
|
cURL request:
|
|
|
|
```sh
|
|
curl -v --request POST \
|
|
--url http://localhost:8080/videos \
|
|
-F 'json={"name": "Cargo.lock"};type=application/json' \
|
|
-F file=@./Cargo.lock
|
|
```
|
|
|
|
[`MultipartForm`]: struct@form::MultipartForm
|
|
|
|
<!-- cargo-rdme end -->
|
|
|
|
[More available in the examples repo →](https://github.com/actix/examples/tree/master/forms/multipart)
|