1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2025-03-13 14:52:40 +00:00
actix-web/actix-multipart/README.md
2025-02-06 07:15:01 +08:00

2.8 KiB

actix-multipart

crates.io Documentation Version MIT or Apache 2.0 licensed
dependency status Download Chat on Discord

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_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 {
    #[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())
            .app_data(MultipartFormConfig::default().total_limit(100 * 1024 * 1024))
    })
    .workers(2)
    .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.lock

More available in the examples repo →