//! # Support for `TypedHeader` //! //! ## Feature //! //! Enable the `typed_header` feature to use `Valid>`. //! //! ## Usage //! //! 1. Implement `Header` and `Validate` for your data type `T`. //! 2. In your handler function, use `Valid>` as some parameter's type. //! //! ## Example //! //! ```no_run //! #[cfg(feature = "validator")] //! mod validator_example { //! use axum_extra::headers::{Error, Header, HeaderValue}; //! use axum_extra::typed_header::TypedHeader; //! use axum::http::HeaderName; //! use axum::routing::post; //! use axum::Router; //! use axum_valid::Valid; //! use validator::Validate; //! //! pub fn router() -> Router { //! Router::new().route("/typed_header", post(handler)) //! } //! //! async fn handler(Valid(TypedHeader(parameter)): Valid>) { //! assert!(parameter.validate().is_ok()); //! } //! //! #[derive(Validate)] //! pub struct Parameter { //! #[validate(range(min = 5, max = 10))] //! pub v0: i32, //! #[validate(length(min = 1, max = 10))] //! pub v1: String, //! } //! //! static HEADER_NAME: HeaderName = HeaderName::from_static("my-header"); //! //! impl Header for Parameter { //! fn name() -> &'static HeaderName { //! &HEADER_NAME //! } //! //! fn decode<'i, I>(_values: &mut I) -> Result //! where //! Self: Sized, //! I: Iterator, //! { //! todo!() //! } //! //! fn encode>(&self, _values: &mut E) { //! todo!() //! } //! } //! } //! //! #[cfg(feature = "garde")] //! mod garde_example { //! use axum_extra::headers::{Error, Header, HeaderValue}; //! use axum_extra::typed_header::TypedHeader; //! use axum::http::HeaderName; //! use axum::routing::post; //! use axum::Router; //! use axum_valid::Garde; //! use garde::Validate; //! //! pub fn router() -> Router { //! Router::new().route("/typed_header", post(handler)) //! } //! //! async fn handler(Garde(TypedHeader(parameter)): Garde>) { //! assert!(parameter.validate(&()).is_ok()); //! } //! //! #[derive(Validate)] //! pub struct Parameter { //! #[garde(range(min = 5, max = 10))] //! pub v0: i32, //! #[garde(length(min = 1, max = 10))] //! pub v1: String, //! } //! //! static HEADER_NAME: HeaderName = HeaderName::from_static("my-header"); //! //! impl Header for Parameter { //! fn name() -> &'static HeaderName { //! &HEADER_NAME //! } //! //! fn decode<'i, I>(_values: &mut I) -> Result //! where //! Self: Sized, //! I: Iterator, //! { //! todo!() //! } //! //! fn encode>(&self, _values: &mut E) { //! todo!() //! } //! } //! } //! //! # #[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_extra::typed_header::TypedHeader; #[cfg(feature = "validator")] use validator::ValidateArgs; impl HasValidate for TypedHeader { type Validate = T; fn get_validate(&self) -> &T { &self.0 } } #[cfg(feature = "validator")] impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for TypedHeader { type ValidateArgs = T; fn get_validate_args(&self) -> &Self::ValidateArgs { &self.0 } } #[cfg(feature = "validify")] impl crate::HasModify for TypedHeader { type Modify = T; fn get_modify(&mut self) -> &mut Self::Modify { &mut self.0 } } #[cfg(test)] mod tests { use crate::tests::{ValidTest, ValidTestParameter}; use axum::http::StatusCode; use axum_extra::headers::Header; use axum_extra::typed_header::TypedHeader; use reqwest::header::{HeaderMap, HeaderValue}; use reqwest::RequestBuilder; impl ValidTest for TypedHeader { const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST; fn set_valid_request(builder: RequestBuilder) -> RequestBuilder { let mut vec = Vec::new(); T::valid().encode(&mut vec); let hv = vec.pop().expect("get header value"); let mut headers = HeaderMap::default(); headers.insert( T::name().as_str(), HeaderValue::from_bytes(hv.as_bytes()).expect("build header value"), ); builder.headers(headers) } fn set_error_request(builder: RequestBuilder) -> RequestBuilder { builder } fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder { let mut vec = Vec::new(); T::invalid().encode(&mut vec); let hv = vec.pop().expect("get header value"); let mut headers = HeaderMap::default(); headers.insert( T::name().as_str(), HeaderValue::from_bytes(hv.as_bytes()).expect("build header value"), ); builder.headers(headers) } } }