-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
351 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| //! # Support for `Cbor<T>` | ||
| //! | ||
| //! ## Feature | ||
| //! | ||
| //! Enable the `cbor` feature to use `Valid<Cbor<T>>`. | ||
| //! | ||
| //! ## Usage | ||
| //! | ||
| //! 1. Implement `Deserialize` and `Validate` for your data type `T`. | ||
| //! 2. In your handler function, use `Valid<Cbor<T>>` as some parameter's type. | ||
| //! | ||
| //! ## Example | ||
| //! | ||
| //! ```no_run | ||
| //! #[cfg(feature = "validator")] | ||
| //! mod validator_example { | ||
| //! use axum::routing::post; | ||
| //! use axum_serde::Cbor; | ||
| //! use axum::Router; | ||
| //! use axum_valid::Valid; | ||
| //! use serde::Deserialize; | ||
| //! use validator::Validate; | ||
| //! | ||
| //! pub fn router() -> Router { | ||
| //! Router::new().route("/cbor", post(handler)) | ||
| //! } | ||
| //! | ||
| //! async fn handler(Valid(Cbor(parameter)): Valid<Cbor<Parameter>>) { | ||
| //! assert!(parameter.validate().is_ok()); | ||
| //! // Support automatic dereferencing | ||
| //! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1); | ||
| //! } | ||
| //! | ||
| //! #[derive(Validate, Deserialize)] | ||
| //! pub struct Parameter { | ||
| //! #[validate(range(min = 5, max = 10))] | ||
| //! pub v0: i32, | ||
| //! #[validate(length(min = 1, max = 10))] | ||
| //! pub v1: String, | ||
| //! } | ||
| //! } | ||
| //! | ||
| //! #[cfg(feature = "garde")] | ||
| //! mod garde_example { | ||
| //! use axum::routing::post; | ||
| //! use axum_serde::Cbor; | ||
| //! use axum::Router; | ||
| //! use axum_valid::Garde; | ||
| //! use serde::Deserialize; | ||
| //! use garde::Validate; | ||
| //! | ||
| //! pub fn router() -> Router { | ||
| //! Router::new().route("/cbor", post(handler)) | ||
| //! } | ||
| //! | ||
| //! async fn handler(Garde(Cbor(parameter)): Garde<Cbor<Parameter>>) { | ||
| //! assert!(parameter.validate(&()).is_ok()); | ||
| //! // Support automatic dereferencing | ||
| //! println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1); | ||
| //! } | ||
| //! | ||
| //! #[derive(Validate, Deserialize)] | ||
| //! pub struct Parameter { | ||
| //! #[garde(range(min = 5, max = 10))] | ||
| //! pub v0: i32, | ||
| //! #[garde(length(min = 1, max = 10))] | ||
| //! pub v1: String, | ||
| //! } | ||
| //! } | ||
| //! | ||
| //! # #[tokio::main] | ||
| //! # async fn main() -> anyhow::Result<()> { | ||
| //! # use std::net::SocketAddr; | ||
| //! # use axum::Router; | ||
| //! # use tokio::net::TcpListener; | ||
| //! # let router = Router::new(); | ||
| //! # #[cfg(feature = "validator")] | ||
| //! # let router = router.nest("/validator", validator_example::router()); | ||
| //! # #[cfg(feature = "garde")] | ||
| //! # let router = router.nest("/garde", garde_example::router()); | ||
| //! # let listener = TcpListener::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16))).await?; | ||
| //! # axum::serve(listener, router.into_make_service()) | ||
| //! # .await?; | ||
| //! # Ok(()) | ||
| //! # } | ||
| //! ``` | ||
|
|
||
| use crate::HasValidate; | ||
| #[cfg(feature = "validator")] | ||
| use crate::HasValidateArgs; | ||
| use axum_serde::Cbor; | ||
| #[cfg(feature = "validator")] | ||
| use validator::ValidateArgs; | ||
|
|
||
| impl<T> HasValidate for Cbor<T> { | ||
| type Validate = T; | ||
| fn get_validate(&self) -> &T { | ||
| &self.0 | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "validator")] | ||
| impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for Cbor<T> { | ||
| type ValidateArgs = T; | ||
| fn get_validate_args(&self) -> &Self::ValidateArgs { | ||
| &self.0 | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "validify")] | ||
| impl<T: validify::Modify> crate::HasModify for Cbor<T> { | ||
| type Modify = T; | ||
|
|
||
| fn get_modify(&mut self) -> &mut Self::Modify { | ||
| &mut self.0 | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "validify")] | ||
| impl<T> crate::PayloadExtractor for Cbor<T> { | ||
| type Payload = T; | ||
|
|
||
| fn get_payload(self) -> Self::Payload { | ||
| self.0 | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "validify")] | ||
| impl<T: validify::Validify + validify::ValidifyPayload> crate::HasValidify for Cbor<T> { | ||
| type Validify = T; | ||
| type PayloadExtractor = Cbor<T::Payload>; | ||
| fn from_validify(v: Self::Validify) -> Self { | ||
| Cbor(v) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use crate::tests::{ValidTest, ValidTestParameter}; | ||
| use axum::http::StatusCode; | ||
| use axum_serde::Cbor; | ||
| use reqwest::RequestBuilder; | ||
| use serde::Serialize; | ||
|
|
||
| impl<T: ValidTestParameter + Serialize> ValidTest for Cbor<T> { | ||
| const ERROR_STATUS_CODE: StatusCode = StatusCode::UNPROCESSABLE_ENTITY; | ||
|
|
||
| fn set_valid_request(builder: RequestBuilder) -> RequestBuilder { | ||
| let mut vec = Vec::new(); | ||
| ciborium::ser::into_writer(&T::valid(), &mut vec) | ||
| .expect("Failed to serialize parameters to cbor"); | ||
| builder | ||
| .header(reqwest::header::CONTENT_TYPE, "application/cbor") | ||
| .body(vec) | ||
| } | ||
|
|
||
| fn set_error_request(builder: RequestBuilder) -> RequestBuilder { | ||
| #[derive(Serialize, Default)] | ||
| struct ErrorData { | ||
| error_field: i32, | ||
| } | ||
| let mut vec = Vec::new(); | ||
| ciborium::ser::into_writer(&ErrorData::default(), &mut vec) | ||
| .expect("Failed to serialize parameters to cbor"); | ||
| builder | ||
| .header(reqwest::header::CONTENT_TYPE, "application/cbor") | ||
| .body(vec) | ||
| } | ||
|
|
||
| fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder { | ||
| let mut vec = Vec::new(); | ||
| ciborium::ser::into_writer(&T::invalid(), &mut vec) | ||
| .expect("Failed to serialize parameters to cbor"); | ||
| builder | ||
| .header(reqwest::header::CONTENT_TYPE, "application/cbor") | ||
| .body(vec) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.