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
//! # Support for `TypedMultipart<T>` and `BaseMultipart<T, R>` from `axum_typed_multipart`
//!
//! ## Feature
//!
//! Enable the `typed_multipart` feature to use `Valid<TypedMultipart<T>>` and `Valid<BaseMultipart<T, R>>`.
//!
//! ## Usage
//!
//! 1. Implement `TryFromMultipart` and `Validate` for your data type `T`.
//! 2. In your handler function, use `Valid<TypedMultipart<T>>` or `Valid<BaseMultipart<T, E>` as some parameter's type.
//!
//! ## Example
//!
//! ```no_run
//! use axum::routing::post;
//! use axum::Router;
//! use axum_typed_multipart::{BaseMultipart, TryFromMultipart, TypedMultipart, TypedMultipartError};
//! use axum_valid::Valid;
//! use validator::Validate;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! let router = Router::new()
//! .route("/typed_multipart", post(handler))
//! .route("/base_multipart", post(base_handler));
//! axum::Server::bind(&([0u8, 0, 0, 0], 8080).into())
//! .serve(router.into_make_service())
//! .await?;
//! Ok(())
//! }
//!
//! async fn handler(Valid(TypedMultipart(parameter)): Valid<TypedMultipart<Parameter>>) {
//! assert!(parameter.validate().is_ok());
//! }
//!
//! async fn base_handler(
//! Valid(BaseMultipart {
//! data: parameter, ..
//! }): Valid<BaseMultipart<Parameter, TypedMultipartError>>,
//! ) {
//! assert!(parameter.validate().is_ok());
//! }
//!
//! #[derive(TryFromMultipart, Validate)]
//! struct Parameter {
//! #[validate(range(min = 5, max = 10))]
//! v0: i32,
//! #[validate(length(min = 1, max = 10))]
//! v1: String,
//! }
//! ```
use crate::{HasValidate, HasValidateArgs};
use axum_typed_multipart::{BaseMultipart, TypedMultipart};
use validator::{Validate, ValidateArgs};
impl<T: Validate, R> HasValidate for BaseMultipart<T, R> {
type Validate = T;
fn get_validate(&self) -> &T {
&self.data
}
}
impl<'v, T: ValidateArgs<'v>, R> HasValidateArgs<'v> for BaseMultipart<T, R> {
type ValidateArgs = T;
fn get_validate_args(&self) -> &Self::ValidateArgs {
&self.data
}
}
impl<T: Validate> HasValidate for TypedMultipart<T> {
type Validate = T;
fn get_validate(&self) -> &T {
&self.0
}
}
impl<'v, T: ValidateArgs<'v>> HasValidateArgs<'v> for TypedMultipart<T> {
type ValidateArgs = T;
fn get_validate_args(&self) -> &Self::ValidateArgs {
&self.0
}
}
#[cfg(test)]
mod tests {
use crate::tests::{ValidTest, ValidTestParameter};
use axum::http::StatusCode;
use axum_typed_multipart::{BaseMultipart, TypedMultipart};
use reqwest::multipart::Form;
use reqwest::RequestBuilder;
impl<T: ValidTestParameter, R> ValidTest for BaseMultipart<T, R>
where
Form: From<&'static T>,
{
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::from(T::valid()))
}
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::new())
}
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::from(T::invalid()))
}
}
impl<T: ValidTestParameter> ValidTest for TypedMultipart<T>
where
Form: From<&'static T>,
{
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::from(T::valid()))
}
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::new())
}
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
builder.multipart(Form::from(T::invalid()))
}
}
}