Struct axum_valid::validator::ValidEx
source · pub struct ValidEx<E>(pub E);
Expand description
§ValidEx
data extractor
ValidEx
can be incorporated with extractors from various modules, similar to Valid
.
Two differences exist between ValidEx
and Valid
:
- The inner data type in
ValidEx
implementsValidateArgs
instead ofValidate
. ValidEx
includes a second field that represents arguments used during validation of the first field.
The implementation of ValidateArgs
is often automatically handled by validator’s derive macros
(for more details, please refer to the validator’s documentation).
Although current module documentation predominantly showcases Valid
examples, the usage of ValidEx
is analogous.
Tuple Fields§
§0: E
Implementations§
source§impl<E> ValidEx<E>
impl<E> ValidEx<E>
sourcepub fn into_inner(self) -> E
pub fn into_inner(self) -> E
Consumes the ValidEx
and returns the validated data within.
This returns the E
type which represents the data that has been
successfully validated.
Trait Implementations§
source§impl<State, Extractor, Args> FromRequest<State> for ValidEx<Extractor>where
State: Send + Sync,
Args: Send + Sync + FromRef<State>,
Extractor: for<'v> HasValidateArgs<'v> + FromRequest<State>,
for<'v> <Extractor as HasValidateArgs<'v>>::ValidateArgs: ValidateArgs<'v, Args = &'v Args>,
impl<State, Extractor, Args> FromRequest<State> for ValidEx<Extractor>where
State: Send + Sync,
Args: Send + Sync + FromRef<State>,
Extractor: for<'v> HasValidateArgs<'v> + FromRequest<State>,
for<'v> <Extractor as HasValidateArgs<'v>>::ValidateArgs: ValidateArgs<'v, Args = &'v Args>,
§type Rejection = ValidationRejection<ValidationErrors, <Extractor as FromRequest<State>>::Rejection>
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.
source§impl<State, Extractor, Args> FromRequestParts<State> for ValidEx<Extractor>where
State: Send + Sync,
Args: Send + Sync + FromRef<State>,
Extractor: for<'v> HasValidateArgs<'v> + FromRequestParts<State>,
for<'v> <Extractor as HasValidateArgs<'v>>::ValidateArgs: ValidateArgs<'v, Args = &'v Args>,
impl<State, Extractor, Args> FromRequestParts<State> for ValidEx<Extractor>where
State: Send + Sync,
Args: Send + Sync + FromRef<State>,
Extractor: for<'v> HasValidateArgs<'v> + FromRequestParts<State>,
for<'v> <Extractor as HasValidateArgs<'v>>::ValidateArgs: ValidateArgs<'v, Args = &'v Args>,
§type Rejection = ValidationRejection<ValidationErrors, <Extractor as FromRequestParts<State>>::Rejection>
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§impl<T> OperationInput for ValidEx<T>where
T: OperationInput,
impl<T> OperationInput for ValidEx<T>where
T: OperationInput,
source§fn operation_input(ctx: &mut GenContext, operation: &mut Operation)
fn operation_input(ctx: &mut GenContext, operation: &mut Operation)
Modify the operation. Read more
source§fn inferred_early_responses(
ctx: &mut GenContext,
operation: &mut Operation
) -> Vec<(Option<u16>, Response)>
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. Read more
source§impl<T: TypedPath + Display> TypedPath for ValidEx<T>
impl<T: TypedPath + Display> TypedPath for ValidEx<T>
source§fn with_query_params<T>(self, params: T) -> WithQueryParams<Self, T>
fn with_query_params<T>(self, params: T) -> WithQueryParams<Self, T>
Add query parameters to a path. Read more
impl<E: Copy> Copy for ValidEx<E>
Auto Trait Implementations§
impl<E> Freeze for ValidEx<E>where
E: Freeze,
impl<E> RefUnwindSafe for ValidEx<E>where
E: RefUnwindSafe,
impl<E> Send for ValidEx<E>where
E: Send,
impl<E> Sync for ValidEx<E>where
E: Sync,
impl<E> Unpin for ValidEx<E>where
E: Unpin,
impl<E> UnwindSafe for ValidEx<E>where
E: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<S, T> FromRequest<S, ViaParts> for T
impl<S, T> FromRequest<S, ViaParts> for T
§type Rejection = <T as FromRequestParts<S>>::Rejection
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.
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> ToCompactString for Twhere
T: Display,
impl<T> ToCompactString for Twhere
T: Display,
source§fn to_compact_string(&self) -> CompactString
fn to_compact_string(&self) -> CompactString
Converts the given value to a
CompactString
. Read moresource§impl<T> ValidateIp for Twhere
T: ToString,
impl<T> ValidateIp for Twhere
T: ToString,
source§fn validate_ipv4(&self) -> bool
fn validate_ipv4(&self) -> bool
Validates whether the given string is an IP V4
source§fn validate_ipv6(&self) -> bool
fn validate_ipv6(&self) -> bool
Validates whether the given string is an IP V6
source§fn validate_ip(&self) -> bool
fn validate_ip(&self) -> bool
Validates whether the given string is an IP