409/axum-valid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix doc error

Browse Source
This commit is contained in:
gengteng
2023-10-08 19:14:56 +08:00
parent dd68fe6131
commit c0b78615e8
12 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/extra.rs
View File

@@ -26,6 +26,8 @@
//! #### Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::extract::FromRequestParts;
//! use axum::http::request::Parts;
//! use axum::response::{IntoResponse, Response};
@@ -85,6 +87,8 @@
//! #### Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::extract::FromRequestParts;
//! use axum::http::request::Parts;
//! use axum::http::StatusCode;
@@ -151,6 +155,8 @@
//! #### Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::extract::FromRequestParts;
//! use axum::http::request::Parts;
//! use axum::response::{IntoResponse, Response};

3
src/extra/form.rs
View File

@@ -65,8 +65,9 @@ mod tests {
use crate::tests::{ValidTest, ValidTestParameter};
use axum_extra::extract::Form;
use reqwest::{RequestBuilder, StatusCode};
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Form<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Form<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

3
src/extra/query.rs
View File

@@ -69,8 +69,9 @@ mod tests {
use axum::http::StatusCode;
use axum_extra::extract::Query;
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Query<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Query<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

5
src/form.rs
View File

@@ -12,6 +12,8 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::routing::post;
//! use axum::Form;
//! use axum::Router;
@@ -66,8 +68,9 @@ mod tests {
use axum::http::StatusCode;
use axum::Form;
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Form<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Form<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::UNPROCESSABLE_ENTITY;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

4
src/json.rs
View File

@@ -12,6 +12,7 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::routing::post;
//! use axum::Json;
@@ -67,8 +68,9 @@ mod tests {
use axum::http::StatusCode;
use axum::Json;
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Json<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Json<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::UNPROCESSABLE_ENTITY;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

3
src/lib.rs
View File

@@ -55,10 +55,9 @@ pub use crate::garde::{Garde, GardeRejection};
#[cfg(test)]
mod tests {
use reqwest::{RequestBuilder, StatusCode};
use serde::Serialize;
/// # Valid test parameter
pub trait ValidTestParameter: Serialize + 'static {
pub trait ValidTestParameter: 'static {
/// Create a valid parameter
fn valid() -> &'static Self;
/// Create an error serializable array

6
src/msgpack.rs
View File

@@ -12,6 +12,7 @@
//! ## Example
//!
//! ```no_run
//!#![cfg(feature = "validator")]
//!
//! use axum::routing::post;
//! use axum::Router;
@@ -91,8 +92,9 @@ mod tests {
use axum::http::StatusCode;
use axum_msgpack::{MsgPack, MsgPackRaw};
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for MsgPack<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for MsgPack<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
@@ -119,7 +121,7 @@ mod tests {
}
}
impl<T: ValidTestParameter> ValidTest for MsgPackRaw<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for MsgPackRaw<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

1
src/path.rs
View File

@@ -8,6 +8,7 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::extract::Path;
//! use axum::routing::post;

4
src/query.rs
View File

@@ -12,6 +12,7 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::extract::Query;
//! use axum::routing::post;
@@ -70,8 +71,9 @@ mod tests {
use axum::extract::Query;
use axum::http::StatusCode;
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Query<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Query<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::BAD_REQUEST;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {

2
src/typed_header.rs
View File

@@ -12,6 +12,8 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::headers::{Error, Header, HeaderValue};
//! use axum::http::HeaderName;
//! use axum::routing::post;

2
src/typed_multipart.rs
View File

@@ -12,6 +12,8 @@
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::routing::post;
//! use axum::Router;
//! use axum_typed_multipart::{BaseMultipart, TryFromMultipart, TypedMultipart, TypedMultipartError};

6
src/yaml.rs
View File

@@ -8,11 +8,12 @@
//!
//! 1. Implement `Deserialize` and `Validate` for your data type `T`.
//! 2. In your handler function, use `Valid<Yaml<T>>` as some parameter's type.
//!
//! ## Example
//!
//! ```no_run
//! #![cfg(feature = "validator")]
//!
//! use axum::routing::post;
//! use axum::Router;
//! use axum_valid::Valid;
@@ -70,8 +71,9 @@ mod tests {
use axum::http::StatusCode;
use axum_yaml::Yaml;
use reqwest::RequestBuilder;
use serde::Serialize;
impl<T: ValidTestParameter> ValidTest for Yaml<T> {
impl<T: ValidTestParameter + Serialize> ValidTest for Yaml<T> {
const ERROR_STATUS_CODE: StatusCode = StatusCode::UNSUPPORTED_MEDIA_TYPE;
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {