salvo_oapi/extract/parameter/
header.rs

1use std::fmt::{self, Debug, Display, Formatter};
2use std::ops::{Deref, DerefMut};
3
4use salvo_core::extract::{Extractible, Metadata};
5use salvo_core::http::{ParseError, Request};
6use serde::{Deserialize, Deserializer};
7
8use crate::endpoint::EndpointArgRegister;
9use crate::{Components, Operation, Parameter, ParameterIn, ToSchema};
10
11/// Represents the parameters passed by header.
12pub struct HeaderParam<T, const REQUIRED: bool = true>(Option<T>);
13impl<T> HeaderParam<T, true> {
14    /// Consumes self and returns the value of the parameter.
15    pub fn into_inner(self) -> T {
16        self.0
17            .expect("`HeaderParam<T, true>` into_inner get `None`")
18    }
19}
20impl<T> HeaderParam<T, false> {
21    /// Consumes self and returns the value of the parameter.
22    pub fn into_inner(self) -> Option<T> {
23        self.0
24    }
25}
26
27impl<T> Deref for HeaderParam<T, true> {
28    type Target = T;
29
30    fn deref(&self) -> &Self::Target {
31        self.0
32            .as_ref()
33            .expect("`HeaderParam<T, true>` defref get `None`")
34    }
35}
36impl<T> Deref for HeaderParam<T, false> {
37    type Target = Option<T>;
38
39    fn deref(&self) -> &Self::Target {
40        &self.0
41    }
42}
43
44impl<T> DerefMut for HeaderParam<T, true> {
45    fn deref_mut(&mut self) -> &mut Self::Target {
46        self.0
47            .as_mut()
48            .expect("`HeaderParam<T, true>` defref_mut get `None`")
49    }
50}
51impl<T> DerefMut for HeaderParam<T, false> {
52    fn deref_mut(&mut self) -> &mut Self::Target {
53        &mut self.0
54    }
55}
56
57impl<'de, T, const R: bool> Deserialize<'de> for HeaderParam<T, R>
58where
59    T: Deserialize<'de>,
60{
61    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
62    where
63        D: Deserializer<'de>,
64    {
65        T::deserialize(deserializer).map(|value| Self(Some(value)))
66    }
67}
68// impl<'de, T> Deserialize<'de> for HeaderParam<T, false>
69// where
70//     T: Deserialize<'de>,
71// {
72//     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
73//     where
74//         D: Deserializer<'de>,
75//     {
76//         T::deserialize(deserializer).map(|value| Self(Some(value)))
77//     }
78// }
79
80impl<T, const R: bool> fmt::Debug for HeaderParam<T, R>
81where
82    T: Debug,
83{
84    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
85        self.0.fmt(f)
86    }
87}
88impl<T: Display> Display for HeaderParam<T, true> {
89    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
90        self.0
91            .as_ref()
92            .expect("HeaderParam value should not None.")
93            .fmt(f)
94    }
95}
96
97impl<'ex, T> Extractible<'ex> for HeaderParam<T, true>
98where
99    T: Deserialize<'ex>,
100{
101    fn metadata() -> &'static Metadata {
102        static METADATA: Metadata = Metadata::new("");
103        &METADATA
104    }
105    #[allow(refining_impl_trait)]
106    async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError> {
107        unimplemented!("header parameter can not be extracted from request")
108    }
109    #[allow(refining_impl_trait)]
110    async fn extract_with_arg(req: &'ex mut Request, arg: &str) -> Result<Self, ParseError> {
111        let value = req.header(arg).ok_or_else(|| {
112            ParseError::other(format!(
113                "header parameter {arg} not found or convert to type failed"
114            ))
115        })?;
116        Ok(Self(value))
117    }
118}
119
120impl<'ex, T> Extractible<'ex> for HeaderParam<T, false>
121where
122    T: Deserialize<'ex>,
123{
124    fn metadata() -> &'static Metadata {
125        static METADATA: Metadata = Metadata::new("");
126        &METADATA
127    }
128    #[allow(refining_impl_trait)]
129    async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError> {
130        unimplemented!("header parameter can not be extracted from request")
131    }
132    #[allow(refining_impl_trait)]
133    async fn extract_with_arg(req: &'ex mut Request, arg: &str) -> Result<Self, ParseError> {
134        Ok(Self(req.header(arg)))
135    }
136}
137
138impl<T, const R: bool> EndpointArgRegister for HeaderParam<T, R>
139where
140    T: ToSchema,
141{
142    fn register(components: &mut Components, operation: &mut Operation, arg: &str) {
143        let parameter = Parameter::new(arg)
144            .parameter_in(ParameterIn::Header)
145            .description(format!("Get parameter `{arg}` from request headers."))
146            .schema(T::to_schema(components))
147            .required(R);
148        operation.parameters.insert(parameter);
149    }
150}
151
152#[cfg(test)]
153mod tests {
154    use assert_json_diff::assert_json_eq;
155    use http::header::HeaderValue;
156    use salvo_core::test::TestClient;
157    use serde_json::json;
158
159    use super::*;
160
161    #[test]
162    fn test_required_header_param_into_inner() {
163        let param = HeaderParam::<String, true>(Some("param".to_owned()));
164        assert_eq!("param".to_owned(), param.into_inner());
165    }
166
167    #[test]
168    fn test_required_header_param_deref() {
169        let param = HeaderParam::<String, true>(Some("param".to_owned()));
170        assert_eq!(&"param".to_owned(), param.deref())
171    }
172
173    #[test]
174    fn test_required_header_param_deref_mut() {
175        let mut param = HeaderParam::<String, true>(Some("param".to_owned()));
176        assert_eq!(&mut "param".to_owned(), param.deref_mut())
177    }
178
179    #[test]
180    fn test_header_param_into_inner() {
181        let param = HeaderParam::<String, false>(Some("param".to_owned()));
182        assert_eq!(Some("param".to_owned()), param.into_inner());
183    }
184
185    #[test]
186    fn test_header_param_deref() {
187        let param = HeaderParam::<String, false>(Some("param".to_owned()));
188        assert_eq!(&Some("param".to_owned()), param.deref())
189    }
190
191    #[test]
192    fn test_header_param_deref_mut() {
193        let mut param = HeaderParam::<String, false>(Some("param".to_owned()));
194        assert_eq!(&mut Some("param".to_owned()), param.deref_mut())
195    }
196
197    #[test]
198    fn test_header_param_deserialize() {
199        let param = serde_json::from_str::<HeaderParam<String, true>>(r#""param""#).unwrap();
200        assert_eq!(param.0.unwrap(), "param");
201    }
202
203    #[test]
204    fn test_header_param_debug() {
205        let param = HeaderParam::<String, true>(Some("param".to_owned()));
206        assert_eq!(format!("{param:?}"), r#"Some("param")"#);
207    }
208
209    #[test]
210    fn test_header_param_display() {
211        let param = HeaderParam::<String, true>(Some("param".to_owned()));
212        assert_eq!(format!("{param}"), "param");
213    }
214
215    #[test]
216    fn test_required_header_param_metadata() {
217        let metadata = HeaderParam::<String, true>::metadata();
218        assert_eq!("", metadata.name);
219    }
220
221    #[tokio::test]
222    #[should_panic]
223    async fn test_required_header_prarm_extract() {
224        let mut req = Request::new();
225        let _ = HeaderParam::<String, true>::extract(&mut req).await;
226    }
227
228    #[tokio::test]
229    async fn test_required_header_prarm_extract_with_value() {
230        let mut req = TestClient::get("http://127.0.0.1:5801").build_hyper();
231        req.headers_mut()
232            .append("param", HeaderValue::from_static("param"));
233        let schema = req.uri().scheme().cloned().unwrap();
234        let mut req = Request::from_hyper(req, schema);
235        let result = HeaderParam::<String, true>::extract_with_arg(&mut req, "param").await;
236        assert_eq!(result.unwrap().0.unwrap(), "param");
237    }
238
239    #[tokio::test]
240    #[should_panic]
241    async fn test_required_header_prarm_extract_with_value_panic() {
242        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
243        let schema = req.uri().scheme().cloned().unwrap();
244        let mut req = Request::from_hyper(req, schema);
245        let result = HeaderParam::<String, true>::extract_with_arg(&mut req, "param").await;
246        assert_eq!(result.unwrap().0.unwrap(), "param");
247    }
248
249    #[test]
250    fn test_header_param_metadata() {
251        let metadata = HeaderParam::<String, false>::metadata();
252        assert_eq!("", metadata.name);
253    }
254
255    #[tokio::test]
256    #[should_panic]
257    async fn test_header_prarm_extract() {
258        let mut req = Request::new();
259        let _ = HeaderParam::<String, false>::extract(&mut req).await;
260    }
261
262    #[tokio::test]
263    async fn test_header_prarm_extract_with_value() {
264        let mut req = TestClient::get("http://127.0.0.1:5801").build_hyper();
265        req.headers_mut()
266            .append("param", HeaderValue::from_static("param"));
267        let schema = req.uri().scheme().cloned().unwrap();
268        let mut req = Request::from_hyper(req, schema);
269        let result = HeaderParam::<String, false>::extract_with_arg(&mut req, "param").await;
270        assert_eq!(result.unwrap().0.unwrap(), "param");
271    }
272
273    #[tokio::test]
274    #[should_panic]
275    async fn test_header_prarm_extract_with_value_panic() {
276        let req = TestClient::get("http://127.0.0.1:5801").build_hyper();
277        let schema = req.uri().scheme().cloned().unwrap();
278        let mut req = Request::from_hyper(req, schema);
279        let result = HeaderParam::<String, false>::extract_with_arg(&mut req, "param").await;
280        assert_eq!(result.unwrap().0.unwrap(), "param");
281    }
282
283    #[test]
284    fn test_header_param_register() {
285        let mut components = Components::new();
286        let mut operation = Operation::new();
287        HeaderParam::<String, false>::register(&mut components, &mut operation, "arg");
288
289        assert_json_eq!(
290            operation,
291            json!({
292                "parameters": [
293                    {
294                        "name": "arg",
295                        "in": "header",
296                        "description": "Get parameter `arg` from request headers.",
297                        "required": false,
298                        "schema": {
299                            "type": "string"
300                        }
301                    }
302                ],
303                "responses": {}
304            })
305        )
306    }
307}
salvo_oapi/extract/parameter/header.rs

salvo_oapi/extract/parameter/
header.rs
