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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
//! Functionality for using `serde_qs` with `axum`.
//!
//! Enable with the `axum` feature.
use axum_framework as axum;
use std::sync::Arc;
use crate::de::Config as QsConfig;
use crate::error::Error as QsError;
use axum::{
extract::{Extension, FromRequestParts},
http::StatusCode,
response::{IntoResponse, Response},
BoxError, Error,
};
#[derive(Clone, Copy, Default)]
/// Extract typed information from from the request's query.
///
/// ## Example
///
/// ```rust
/// # extern crate axum_framework as axum;
/// use serde_qs::axum::QsQuery;
/// use serde_qs::Config;
/// use axum::{response::IntoResponse, routing::get, Router, body::Body};
///
/// #[derive(serde::Deserialize)]
/// pub struct UsersFilter {
/// id: Vec<u64>,
/// }
///
/// async fn filter_users(
/// QsQuery(info): QsQuery<UsersFilter>
/// ) -> impl IntoResponse {
/// info.id
/// .iter()
/// .map(|i| i.to_string())
/// .collect::<Vec<String>>()
/// .join(", ")
/// }
///
/// fn main() {
/// let app = Router::<()>::new()
/// .route("/users", get(filter_users));
/// }
pub struct QsQuery<T>(pub T);
impl<T> std::ops::Deref for QsQuery<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl<T: std::fmt::Display> std::fmt::Display for QsQuery<T> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.0.fmt(f)
}
}
impl<T: std::fmt::Debug> std::fmt::Debug for QsQuery<T> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.0.fmt(f)
}
}
#[axum::async_trait]
impl<T, S> FromRequestParts<S> for QsQuery<T>
where
T: serde::de::DeserializeOwned,
S: Send + Sync,
{
type Rejection = QsQueryRejection;
async fn from_request_parts(
parts: &mut axum::http::request::Parts,
state: &S,
) -> Result<Self, Self::Rejection> {
let Extension(qs_config) = Extension::<QsQueryConfig>::from_request_parts(parts, state)
.await
.unwrap_or_else(|_| Extension(QsQueryConfig::default()));
let error_handler = qs_config.error_handler.clone();
let config: QsConfig = qs_config.into();
let query = parts.uri.query().unwrap_or_default();
match config.deserialize_str::<T>(query) {
Ok(value) => Ok(QsQuery(value)),
Err(err) => match error_handler {
Some(handler) => Err((handler)(err)),
None => Err(QsQueryRejection::new(err, StatusCode::BAD_REQUEST)),
},
}
}
}
#[derive(Debug)]
/// Rejection type for extractors that deserialize query strings
pub struct QsQueryRejection {
error: axum::Error,
status: StatusCode,
}
impl std::fmt::Display for QsQueryRejection {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Failed to deserialize query string. Error: {}",
self.error,
)
}
}
impl QsQueryRejection {
/// Create new rejection
pub fn new<E>(error: E, status: StatusCode) -> Self
where
E: Into<BoxError>,
{
QsQueryRejection {
error: Error::new(error),
status,
}
}
}
impl IntoResponse for QsQueryRejection {
fn into_response(self) -> Response {
let mut res = self.to_string().into_response();
*res.status_mut() = self.status;
res
}
}
impl std::error::Error for QsQueryRejection {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
Some(&self.error)
}
}
#[derive(Clone)]
/// Query extractor configuration
///
/// QsQueryConfig wraps [`Config`](crate::de::Config) and implement [`Clone`]
/// for [`FromRequest`](https://docs.rs/axum/0.5/axum/extract/trait.FromRequest.html)
///
/// ## Example
///
/// ```rust
/// # extern crate axum_framework as axum;
/// use serde_qs::axum::{QsQuery, QsQueryConfig, QsQueryRejection};
/// use serde_qs::Config;
/// use axum::{
/// response::IntoResponse,
/// routing::get,
/// Router,
/// body::Body,
/// extract::Extension,
/// http::StatusCode,
/// };
/// use std::sync::Arc;
///
/// #[derive(serde::Deserialize)]
/// pub struct UsersFilter {
/// id: Vec<u64>,
/// }
///
/// async fn filter_users(
/// QsQuery(info): QsQuery<UsersFilter>
/// ) -> impl IntoResponse {
/// info.id
/// .iter()
/// .map(|i| i.to_string())
/// .collect::<Vec<String>>()
/// .join(", ")
/// }
///
/// fn main() {
/// let app = Router::<()>::new()
/// .route("/users", get(filter_users))
/// .layer(Extension(QsQueryConfig::new(5, false)
/// .error_handler(|err| {
/// QsQueryRejection::new(err, StatusCode::UNPROCESSABLE_ENTITY)
/// })));
/// }
pub struct QsQueryConfig {
max_depth: usize,
strict: bool,
error_handler: Option<Arc<dyn Fn(QsError) -> QsQueryRejection + Send + Sync>>,
}
impl QsQueryConfig {
/// Create new config wrapper
pub fn new(max_depth: usize, strict: bool) -> Self {
Self {
max_depth,
strict,
error_handler: None,
}
}
/// Set custom error handler
pub fn error_handler<F>(mut self, f: F) -> Self
where
F: Fn(QsError) -> QsQueryRejection + Send + Sync + 'static,
{
self.error_handler = Some(Arc::new(f));
self
}
}
impl From<QsQueryConfig> for QsConfig {
fn from(config: QsQueryConfig) -> Self {
Self::new(config.max_depth, config.strict)
}
}
impl Default for QsQueryConfig {
fn default() -> Self {
Self {
max_depth: 5,
strict: true,
error_handler: None,
}
}
}
|
