Add multipart/form-data response builders to axum-extra #2654
Conversation
|
I may need some help fixing those CI errors, I am unsure how to address them |
|
Ok, I managed to fix all of those CI errors, thank you for your patience |
axum-extra/src/multipart_builder.rs
Outdated
| /// .part(Part::text("other_field_name", "def")) | ||
| /// .part(Part::file("file", "file.txt", vec![0x68, 0x68, 0x20, 0x6d, 0x6f, 0x6d])); | ||
| /// ``` | ||
| pub fn part(&mut self, part: Part) -> &mut Self { |
There was a problem hiding this comment.
I think this should be named so it's clearer what it does, e.g. add_part or push_part.
Personally, I'm not also sure this API is that useful,wouldn't it be better to just have something like parts_mut which would return a mutable reference to the parts vector and then the user can just push there directly, but also remove stuff, clear it, or any other operation they might need to take.
On the other hand they can just build the vector beforehand and then call from_parts just before returning the response.
There was a problem hiding this comment.
You're right, it did feel kind of odd, I was trying to create something similar to Reqwest's implementation (.part()) chained calls, but with .with_parts() it feels redundant, so I removed it. I can add parts_mut if you feel it would prudent.
| @@ -83,6 +83,9 @@ pub mod routing; | |||
| #[cfg(feature = "json-lines")] | |||
| pub mod json_lines; | |||
|
|
|||
| #[cfg(feature = "multipart")] | |||
| pub mod multipart_builder; | |||
There was a problem hiding this comment.
There's already a Multipart extractor, so I wanted to clarify between that and the functionality for creating forms.
jplatte
changed the title
|
I have commit ready to fix some of those minor issues, I just need to figure out how to handle mime type stuff from a public api level |
Closes #2624 (mine)
This pull request provides builders that enable
multipart/form-dataforms to be returned from handlers.Motivation
multipart/form-dataforms provide a way to include multiple types of data in a single response as key value pairs. You could include an image and a JSON, or any other combination of data.As an example, this could be used for a pastebin, so that a single request to an axum backend could return metadata about a paste in a json, and the paste itself. The paste wouldn't need to conform to UTF-8, and could be sent separately from the json.
Solution
I added a
MultipartFormstruct that implementsIntoResponse, and implementers can add parts to that form by definingParts. I did not implementIntoResponseon theMultipartextractor, as advised in the original issue.One dependency was added if the
multipartfeature is enabled.fastrandis used to generate boundaries, mirroring Reqwest's implementation.Thank you for your time :)