ohkami 0.24.9

A performant, declarative, and runtime-flexible web framework for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use super::super::bound::{self, Incoming};
use super::FromContent;
use ohkami_lib::serde_multipart;

pub use ohkami_lib::serde_multipart::File;

#[cfg(feature = "openapi")]
use crate::openapi;

/// # multipart/form-data format
///
/// When `openapi` feature is activated, schema bound additionally
/// requires `openapi::Schema`.
///
/// ## Request
///
/// - content type: `multipart/form-data`
/// - schema bound: `Deserialize<'_>`
///
/// ### example
///
/// ```
/// # enum MyError {}
/// use ohkami::claw::content::{Multipart, File};
/// use ohkami::serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct SignUpForm<'req> {
///     #[serde(rename = "user-name")]
///     user_name:  &'req str,
///
///     password:   &'req str,
///     
///     #[serde(rename = "user-icon")]
///     user_icon:  Option<File<'req>>,
///
///     #[serde(rename = "pet-photos")]
///     pet_photos: Vec<File<'req>>,
/// }
///
/// async fn sign_up(
///     Multipart(form): Multipart<SignUpForm<'_>>,
/// ) -> Result<(), MyError> {
///     todo!()
/// }
/// ```
///
/// ## Response
///
/// not supported
pub struct Multipart<T: bound::Schema>(pub T);

impl<'req, T: Incoming<'req>> FromContent<'req> for Multipart<T> {
    const MIME_TYPE: &'static str = "multipart/form-data";

    fn from_content(body: &'req [u8]) -> Result<Self, impl std::fmt::Display> {
        serde_multipart::from_bytes(body).map(Multipart)
    }

    #[cfg(feature = "openapi")]
    fn openapi_requestbody() -> impl Into<openapi::schema::SchemaRef> {
        T::schema()
    }
}