14 releases

new 0.5.0 Sep 14, 2020
0.4.0 Jun 6, 2019
0.4.0-beta.2 May 9, 2019
0.3.2 Jan 19, 2019
0.3.0 Jul 25, 2018

#29 in HTTP server

Download history 51/week @ 2020-05-28 61/week @ 2020-06-04 28/week @ 2020-06-11 36/week @ 2020-06-18 13/week @ 2020-06-25 40/week @ 2020-07-02 40/week @ 2020-07-09 30/week @ 2020-07-16 30/week @ 2020-07-23 32/week @ 2020-07-30 50/week @ 2020-08-06 29/week @ 2020-08-13 26/week @ 2020-08-20 24/week @ 2020-08-27 59/week @ 2020-09-03 37/week @ 2020-09-10

139 downloads per month

GPL-3.0 license

350KB
771 lines

Actix Form Data

A library for retrieving form data from Actix Web's multipart streams. It can stream uploaded files onto the filesystem (its main purpose), but it can also parse associated form data.

Usage

Add it to your dependencies.

# Cargo.toml

[dependencies]
actix-web = "1.0.0"
actix-form-data = "0.5.0-alpha.0"

Require it in your project.

// src/lib.rs or src/main.rs

use form_data::{Field, Form, Value};

Overview

First, you'd create a form structure you want to parse from the multipart stream.

let form = Form::new().field("field-name", Field::text());

This creates a form with one required field named "field-name" that will be parsed as text.

Then, pass it as a middleware.

App::new()
    .wrap(form.clone())
    .service(resource("/upload").route(post().to(upload)))

In your handler, get the value

async fn upload(value: Value) ->  {
    ...
}

And interact with it

let field_value = match value {
    Value::Map(mut hashmap) => {
        hashmap.remove("field-name")?;
    }
    _ => return None,
};

...

Example

/// examples/simple.rs

use actix_form_data::{Error, Field, Form, Value};
use actix_web::{
    web::{post, resource},
    App, HttpResponse, HttpServer,
};
use futures::stream::StreamExt;

async fn upload(uploaded_content: Value) -> HttpResponse {
    println!("Uploaded Content: {:#?}", uploaded_content);
    HttpResponse::Created().finish()
}

#[actix_rt::main]
async fn main() -> Result<(), anyhow::Error> {
    let form = Form::new()
        .field("Hey", Field::text())
        .field(
            "Hi",
            Field::map()
                .field("One", Field::int())
                .field("Two", Field::float())
                .finalize(),
        )
        .field(
            "files",
            Field::array(Field::file(|_, _, mut stream| async move {
                while let Some(res) = stream.next().await {
                    res?;
                }
                Ok(()) as Result<(), Error>
            })),
        );

    println!("{:?}", form);

    HttpServer::new(move || {
        App::new()
            .wrap(form.clone())
            .service(resource("/upload").route(post().to(upload)))
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await?;

    Ok(())
}

Contributing

Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the GPLv3.

License

Copyright © 2020 Riley Trautman

Actix Form Data is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Actix Form Data is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of Actix Form Data.

You should have received a copy of the GNU General Public License along with Actix Form Data. If not, see http://www.gnu.org/licenses/.

Dependencies

~20MB
~472K SLoC