Struct axum_valid::validator::Valid

pub struct Valid<E>(pub E);

Valid data extractor

This extractor can be used in combination with axum’s extractors like Json, Form, Query, Path, etc to validate their inner data automatically. It can also work with custom extractors that implement the HasValidate trait.

See the docs for each integration module to find examples of using Valid with that extractor.

For examples with custom extractors, check out the tests/custom.rs file.

Tuple Fields

0: E

Implementations

impl<E> Valid<E>

pub fn into_inner(self) -> E

Consume the Valid extractor and returns the inner type.

Trait Implementations

impl<E: Clone> Clone for Valid<E>

fn clone(&self) -> Valid<E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for Valid<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: Default> Default for Valid<E>

fn default() -> Valid<E>

Returns the “default value” for a type.

impl<E> Deref for Valid<E>

type Target = E

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<E> DerefMut for Valid<E>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Display> Display for Valid<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<State, Extractor> FromRequest<State> for Valid<Extractor>

where State: Send + Sync, Extractor: HasValidate + FromRequest<State>, Extractor::Validate: Validate,

type Rejection = ValidationRejection<ValidationErrors, <Extractor as FromRequest<State>>::Rejection>

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: Request, state: &'life0 State ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl<State, Extractor> FromRequestParts<State> for Valid<Extractor>

where State: Send + Sync, Extractor: HasValidate + FromRequestParts<State>, Extractor::Validate: Validate,

type Rejection = ValidationRejection<ValidationErrors, <Extractor as FromRequestParts<State>>::Rejection>

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, state: &'life1 State ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.

impl<T> OperationInput for Valid<T>

where T: OperationInput,

fn operation_input(ctx: &mut GenContext, operation: &mut Operation)

Modify the operation.

fn inferred_early_responses( ctx: &mut GenContext, operation: &mut Operation ) -> Vec<(Option<u16>, Response)>

Inferred early responses are used to document early returns for extractors, guards inside handlers. For example these could represent JSON parsing errors, authentication failures.

impl<T: TypedPath + Display> TypedPath for Valid<T>

const PATH: &'static str = T::PATH

The path with optional captures such as /users/:id.

fn to_uri(&self) -> Uri

Convert the path into a Uri.

fn with_query_params<T>(self, params: T) -> WithQueryParams<Self, T>

where T: Serialize, Self: Sized,

Add query parameters to a path.

impl<E: Copy> Copy for Valid<E>