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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use super::super::bound::{self, Incoming, Outgoing};
use super::{FromContent, IntoContent};
use ohkami_lib::serde_urlencoded;
use std::borrow::Cow;

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

/// # URL encoded format
///
/// When `openapi` feature is activated, schema bound additionally
/// requires `openapi::Schema`.
///
/// ## Request
///
/// - content type: `application/x-www-form-urlencoded`
/// - schema bound: `Deserialize<'_>`
///
/// ### example
///
/// ```
/// # enum MyError {}
/// use ohkami::claw::content::UrlEncoded;
/// use ohkami::serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct CreateUserRequest<'req> {
///     name: &'req str,
///     age: Option<u8>,
/// }
///
/// async fn create_user(
///     UrlEncoded(body): UrlEncoded<CreateUserRequest<'_>>,
/// ) -> Result<(), MyError> {
///     todo!()
/// }
/// ```
///
/// ## Response
///
/// - content type: `application/x-www-form-urlencoded`
/// - schema bound: `Serialize`
///
/// ### example
///
/// ```
/// # enum MyError {}
/// use ohkami::claw::content::UrlEncoded;
/// use ohkami::serde::Serialize;
///
/// #[derive(Serialize)]
/// struct User {
///     name: String,
///     age: Option<u8>,
/// }
///
/// async fn get_user(
///     id: &str,
/// ) -> Result<UrlEncoded<User>, MyError> {
///     todo!()
/// }
/// ```
pub struct UrlEncoded<T: bound::Schema>(pub T);

impl<'req, T: Incoming<'req>> FromContent<'req> for UrlEncoded<T> {
    const MIME_TYPE: &'static str = "application/x-www-form-urlencoded";

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

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

impl<T: Outgoing> IntoContent for UrlEncoded<T> {
    const CONTENT_TYPE: &'static str = "application/x-www-form-urlencoded";

    fn into_content(self) -> Result<Cow<'static, [u8]>, impl std::fmt::Display> {
        serde_urlencoded::to_string(&self.0).map(|s| Cow::Owned(s.into_bytes()))
    }

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