Struct axum_valid::validator::Valid

source · 
pub struct Valid<E>(pub E);
Expand description

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§

source§

impl<E> Valid<E>

source

pub fn into_inner(self) -> E

Consume the Valid extractor and returns the inner type.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> Valid<E>

Returns the “default value” for a type. Read more
source§

impl<E> Deref for Valid<E>

§

type Target = E

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<E> DerefMut for Valid<E>

source§

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

Mutably dereferences the value.
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<State, Body, Extractor> FromRequest<State, Body> for Valid<Extractor>
where State: Send + Sync, Body: Send + Sync + 'static, Extractor: HasValidate + FromRequest<State, Body>, Extractor::Validate: Validate,

§

type Rejection = ValidationRejection<ValidationErrors, <Extractor as FromRequest<State, Body>>::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.
source§

fn from_request<'life0, 'async_trait>( req: Request<Body>, 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.
source§

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.
source§

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.
source§

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

source§

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

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

fn to_uri(&self) -> Uri

Convert the path into a Uri. Read more
source§

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

Add query parameters to a path. Read more
source§

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

Auto Trait Implementations§

§

impl<E> RefUnwindSafe for Valid<E>
where E: RefUnwindSafe,

§

impl<E> Send for Valid<E>
where E: Send,

§

impl<E> Sync for Valid<E>
where E: Sync,

§

impl<E> Unpin for Valid<E>
where E: Unpin,

§

impl<E> UnwindSafe for Valid<E>
where E: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<S, B, T> FromRequest<S, B, ViaParts> for T
where B: Send + 'static, S: Send + Sync, T: FromRequestParts<S>,

§

type Rejection = <T as FromRequestParts<S>>::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<B>, state: &'life0 S ) -> Pin<Box<dyn Future<Output = Result<T, <T as FromRequest<S, B, ViaParts>>::Rejection>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: 'async_trait,

Perform the extraction.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> ToCompactString for T
where T: Display,

§

fn to_compact_string(&self) -> CompactString

Converts the given value to a [CompactString]. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more