Struct axum_valid::validify::Modified

pub struct Modified<E>(pub E);

Modified data extractor / response

Extractor

Modified uses validify’s modification capabilities to alter data, without validation.

Operations like trimming and case modification can be done based on modify attributes.

Response

Modified also implements the IntoResponse trait. When its inner IntoResponse type also implements the HasModify trait:

Modified will call validify’s modify method to alter the inner data. Then call the inner type’s own into_response method to convert it into a HTTP response.

This allows applying modifications during response conversion by leveraging validify.

Tuple Fields

0: E

Implementations

impl<E> Modified<E>

pub fn into_inner(self) -> E

Consumes the Modified and returns the modified data within.

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

Trait Implementations

impl<E: Clone> Clone for Modified<E>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for Modified<E>

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

Formats the value using the given formatter.

impl<E: Default> Default for Modified<E>

fn default() -> Modified<E>

Returns the “default value” for a type.

impl<E> Deref for Modified<E>

type Target = E

The resulting type after dereferencing.

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

Dereferences the value.

impl<E> DerefMut for Modified<E>

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

Mutably dereferences the value.

impl<T: Display> Display for Modified<T>

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

Formats the value using the given formatter.

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

where State: Send + Sync, Extractor: HasModify + FromRequest<State>,

type Rejection = <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 Modified<Extractor>

where State: Send + Sync, Extractor: HasModify + FromRequestParts<State>,

type Rejection = <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<E: IntoResponse + HasModify> IntoResponse for Modified<E>

fn into_response(self) -> Response

Create a response.

impl<T> OperationInput for Modified<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> OperationOutput for Modified<T>

where T: OperationOutput,

type Inner = <T as OperationOutput>::Inner

The type that is used in examples.

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

Return a response documentation for this type, alternatively modify the operation if required.

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

Inferred responses are used when the type is used as a request handler return type.

impl<T: TypedPath + Display> TypedPath for Modified<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 Modified<E>