Struct actix_web_validator::QsQuery

pub struct QsQuery<T>(pub T);

Extract and validate typed information from the request’s query (serde_qs based).

For query decoding uses serde_qs crate QsQueryConfig allows to configure extraction process.

Example

use actix_web::{web, App};
use serde::Deserialize;
use actix_web_validator::QsQuery;
use validator::Validate;

#[derive(Debug, Deserialize)]
pub enum ResponseType {
    Token,
    Code
}

#[derive(Deserialize, Validate)]
pub struct AuthRequest {
    #[validate(range(min = 1000, max = 9999))]
    id: u64,
    response_type: ResponseType,
}

// Use `Query` extractor for query information (and destructure it within the signature).
// This handler gets called only if the request's query string contains a `id` and
// `response_type` fields.
// The correct request for this handler would be `/index.html?id=1234&response_type=Code"`.
async fn index(info: QsQuery<AuthRequest>) -> String {
    format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type)
}

fn main() {
    let app = App::new().service(
        web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor
}

Implementations

impl<T> QsQuery<T> where
    T: Validate, 

pub fn into_inner(self) -> T

Deconstruct to an inner value.

Trait Implementations

impl<T> AsRef<T> for QsQuery<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Debug> Debug for QsQuery<T>

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

Formats the value using the given formatter.

impl<T> Deref for QsQuery<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for QsQuery<T>

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

Mutably dereferences the value.

impl<T: Display> Display for QsQuery<T>

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

Formats the value using the given formatter.

impl<T> FromRequest for QsQuery<T> where
    T: DeserializeOwned + Validate, 

Extract typed information from the request’s query.

Example

use actix_web::{web, App};
use serde::Deserialize;
use actix_web_validator::QsQuery;
use validator::Validate;

#[derive(Debug, Deserialize)]
pub enum ResponseType {
    Token,
    Code
}

#[derive(Deserialize, Validate)]
pub struct AuthRequest {
    #[validate(range(min = 1000, max = 9999))]
    id: u64,
    response_type: ResponseType,
}

// Use `Query` extractor for query information (and destructure it within the signature).
// This handler gets called only if the request's query string contains a `id` and
// `response_type` fields.
// The correct request for this handler would be `/index.html?id=19&response_type=Code"`.
async fn index(QsQuery(info): QsQuery<AuthRequest>) -> String {
    format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type)
}

fn main() {
    let app = App::new().service(
       web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor
}

fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future

Builds Query struct from request and provides validation mechanism

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Self, Self::Error>>

Future that resolves to a Self

type Config = QsQueryConfig

Configuration for this extractor

fn extract(req: &HttpRequest) -> Self::Future

Convert request to a Self

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl<T: Ord> Ord for QsQuery<T>

fn cmp(&self, other: &QsQuery<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<QsQuery<T>> for QsQuery<T>

fn eq(&self, other: &QsQuery<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &QsQuery<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<QsQuery<T>> for QsQuery<T>

fn partial_cmp(&self, other: &QsQuery<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Eq> Eq for QsQuery<T>

impl<T> StructuralEq for QsQuery<T>

impl<T> StructuralPartialEq for QsQuery<T>