miko 0.9.0

A 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
90
91
92
93
94
95
96

//! ValidatedJson 提取器
//!
//! 自动解析 JSON 并验证，验证失败时自动转换为 AppError::ValidationError
//!
//! 需要启用 `validation` feature

#[cfg(feature = "validation")]
use crate::error::AppError;
#[cfg(feature = "validation")]
use crate::extractor::from_request::{FRFut, FromRequest};
#[cfg(feature = "validation")]
use crate::handler::Req;
#[cfg(feature = "validation")]
use http_body_util::BodyExt;
#[cfg(feature = "validation")]
use serde::de::DeserializeOwned;
#[cfg(feature = "validation")]
use std::sync::Arc;

/// ValidatedJson 提取器
///
/// 自动反序列化 JSON 并执行验证
///
/// # 要求
/// - `T` 必须实现 `serde::Deserialize`
/// - `T` 必须实现 `garde::Validate`
///
/// # Example
/// ```rust,ignore
/// use miko::extractor::ValidatedJson;
/// use garde::Validate;
/// use serde::Deserialize;
///
/// #[derive(Debug, Deserialize, Validate)]
/// struct CreateUser {
///     #[garde(length(min = 3, max = 50))]
///     username: String,
///
///     #[garde(email)]
///     email: String,
///
///     #[garde(length(min = 8))]
///     password: String,
/// }
///
/// async fn create_user(
///     ValidatedJson(user): ValidatedJson<CreateUser>
/// ) -> AppResult<String> {
///     // user 已经通过验证
///     Ok(format!("Created user: {}", user.username))
/// }
/// ```
#[cfg(feature = "validation")]
#[derive(Debug)]
pub struct ValidatedJson<T>(pub T);

#[cfg(feature = "validation")]
impl<S, T> FromRequest<S> for ValidatedJson<T>
where
    T: DeserializeOwned + garde::Validate + Send + Sync + 'static,
    <T as garde::Validate>::Context: Default,
    S: Send + Sync + 'static,
{
    fn from_request(mut req: Req, _state: Arc<S>) -> FRFut<Self> {
        Box::pin(async move {
            let body = req
                .body_mut()
                .collect()
                .await
                .map_err(|e| AppError::BadRequest(format!("Failed to read request body: {}", e)))?
                .to_bytes();

            let value: T = serde_json::from_slice(&body).map_err(AppError::JsonParseError)?;

            value.validate().map_err(AppError::from)?;

            Ok(ValidatedJson(value))
        })
    }
}

#[cfg(feature = "validation")]
impl<T> std::ops::Deref for ValidatedJson<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[cfg(feature = "validation")]
impl<T> std::ops::DerefMut for ValidatedJson<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}