Struct axum_valid::garde::Garde

pub struct Garde<E>(pub E);

Garde data extractor

Garde uses garde to validate data, supporting validation with or without arguments.

If not using arguments, its usage is similar to Valid. However, if your axum router uses a state, you need to implement FromRef<StateType> for ().

If using arguments, you must pass the arguments to Garde extractor via state, meaning implementing FromRef<StateType> for your validation arguments type.

Tuple Fields

0: E

Implementations

impl<E> Garde<E>

pub fn into_inner(self) -> E

Consumes the Garde and returns the validated data within.

This returns the E type which represents the data that has been successfully validated.

Trait Implementations

impl<E: Clone> Clone for Garde<E>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Garde<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for Garde<E>

fn default() -> Garde<E>

Returns the “default value” for a type.

impl<E> Deref for Garde<E>

type Target = E

The resulting type after dereferencing.

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

Dereferences the value.

impl<E> DerefMut for Garde<E>

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

Mutably dereferences the value.

impl<T: Display> Display for Garde<T>

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

Formats the value using the given formatter.

impl<State, Extractor, Context> FromRequest<State> for Garde<Extractor>

where State: Send + Sync, Context: Send + Sync + FromRef<State>, Extractor: HasValidate + FromRequest<State>, <Extractor as HasValidate>::Validate: Validate<Context = Context>,

type Rejection = ValidationRejection<Report, <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, Context> FromRequestParts<State> for Garde<Extractor>

where State: Send + Sync, Context: Send + Sync + FromRef<State>, Extractor: HasValidate + FromRequestParts<State>, <Extractor as HasValidate>::Validate: Validate<Context = Context>,

type Rejection = ValidationRejection<Report, <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 Garde<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 Garde<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 Garde<E>