axum_valid/extra/
query.rs

1//! # Support for `Query<T>` from `axum-extra`
2//!
3//! ## Feature
4//!
5//! Enable the `extra_query` feature to use `Valid<Query<T>>`.
6//!
7//! ## Usage
8//!
9//! 1. Implement `Deserialize` and `Validate` for your data type `T`.
10//! 2. In your handler function, use `Valid<Query<T>>` as some parameter's type.
11//!
12//! ## Example
13//!
14//! ```no_run
15//! #[cfg(feature = "validator")]
16//! mod validator_example {
17//!     use axum_extra::extract::Query;
18//!     use axum::routing::post;
19//!     use axum::Router;
20//!     use axum_valid::Valid;
21//!     use serde::Deserialize;
22//!     use validator::Validate;
23//!
24//!     pub fn router() -> Router {
25//!         Router::new().route("/query", post(handler))
26//!     }
27//!
28//!     async fn handler(Valid(Query(parameter)): Valid<Query<Parameter>>) {
29//!         assert!(parameter.validate().is_ok());
30//!         // Support automatic dereferencing
31//!         println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
32//!     }
33//!
34//!     #[derive(Validate, Deserialize)]
35//!     pub struct Parameter {
36//!         #[validate(range(min = 5, max = 10))]
37//!         pub v0: i32,
38//!         #[validate(length(min = 1, max = 10))]
39//!         pub v1: String,
40//!     }
41//! }
42//!
43//! #[cfg(feature = "garde")]
44//! mod garde_example {
45//!     use axum::routing::post;
46//!     use axum_extra::extract::Query;
47//!     use axum::Router;
48//!     use axum_valid::Garde;
49//!     use serde::Deserialize;
50//!     use garde::Validate;
51//!
52//!     pub fn router() -> Router {
53//!         Router::new().route("/query", post(handler))
54//!     }
55//!
56//!     async fn handler(Garde(Query(parameter)): Garde<Query<Parameter>>) {
57//!         assert!(parameter.validate_with(&()).is_ok());
58//!         // Support automatic dereferencing
59//!         println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
60//!     }
61//!
62//!     #[derive(Validate, Deserialize)]
63//!     pub struct Parameter {
64//!         #[garde(range(min = 5, max = 10))]
65//!         pub v0: i32,
66//!         #[garde(length(min = 1, max = 10))]
67//!         pub v1: String,
68//!     }
69//! }
70//!
71//! # #[tokio::main]
72//! # async fn main() -> anyhow::Result<()> {
73//! #     use std::net::SocketAddr;
74//! #     use axum::Router;
75//! #     use tokio::net::TcpListener;
76//! #     let router = Router::new();
77//! #     #[cfg(feature = "validator")]
78//! #     let router = router.nest("/validator", validator_example::router());
79//! #     #[cfg(feature = "garde")]
80//! #     let router = router.nest("/garde", garde_example::router());
81//! #     let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?;
82//! #     axum::serve(listener, router.into_make_service())
83//! #         .await?;
84//! #     Ok(())
85//! # }
86//! ```
87
88use crate::HasValidate;
89#[cfg(feature = "validator")]
90use crate::HasValidateArgs;
91use axum_extra::extract::Query;
92#[cfg(feature = "validator")]
93use validator::ValidateArgs;
94
95impl<T> HasValidate for Query<T> {
96    type Validate = T;
97    fn get_validate(&self) -> &T {
98        &self.0
99    }
100}
101
102#[cfg(feature = "validator")]
103impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for Query<T> {
104    type ValidateArgs = T;
105    fn get_validate_args(&self) -> &Self::ValidateArgs {
106        &self.0
107    }
108}
109
110#[cfg(feature = "validify")]
111impl<T: validify::Modify> crate::HasModify for Query<T> {
112    type Modify = T;
113
114    fn get_modify(&mut self) -> &mut Self::Modify {
115        &mut self.0
116    }
117}
118
119#[cfg(feature = "validify")]
120impl<T> crate::PayloadExtractor for Query<T> {
121    type Payload = T;
122
123    fn get_payload(self) -> Self::Payload {
124        self.0
125    }
126}
127
128#[cfg(feature = "validify")]
129impl<T: validify::Validify + validify::ValidifyPayload> crate::HasValidify for Query<T> {
130    type Validify = T;
131    type PayloadExtractor = Query<T::Payload>;
132
133    fn from_validify(v: Self::Validify) -> Self {
134        Query(v)
135    }
136}
137
138#[cfg(test)]
139mod tests {
140    use crate::tests::{ValidTest, ValidTestParameter};
141    use axum::http::StatusCode;
142    use axum_extra::extract::Query;
143    use reqwest::RequestBuilder;
144    use serde::Serialize;
145
146    impl<T: ValidTestParameter + Serialize> ValidTest for Query<T> {
147        const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
148
149        fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
150            builder.query(&T::valid())
151        }
152
153        fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
154            builder.query(T::error())
155        }
156
157        fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
158            builder.query(&T::invalid())
159        }
160    }
161}
axum_valid/extra/query.rs

axum_valid/extra/
query.rs
