Struct serde_qs::actix::QsQuery

pub struct QsQuery<T>(_);

Extract typed information from from the request's query.

Example

#[macro_use] extern crate serde_derive;
extern crate actix_web;
use actix_web::{web, App, HttpResponse};
use serde_qs::actix::QsQuery;

#[derive(Deserialize)]
pub struct UsersFilter {
   id: Vec<u64>,
}

// Use `QsQuery` extractor for query information.
// The correct request for this handler would be `/users?id[]=1124&id[]=88"`
fn filter_users(info: QsQuery<UsersFilter>) -> HttpResponse {
    info.id.iter().map(|i| i.to_string()).collect::<Vec<String>>().join(", ").into()
}

fn main() {
    let app = App::new().service(
       web::resource("/users")
           .route(web::get().to(filter_users)));
}

Implementations

impl<T> QsQuery<T>

pub fn into_inner(self) -> T

Deconstruct to a inner value

Trait Implementations

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: Eq> Eq for QsQuery<T>

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

type Error = ActixError

The associated error which can be returned.

type Future = Ready<Result<Self, ActixError>>

Future that resolves to a Self

type Config = QsQueryConfig

Configuration for this extractor

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

Convert request to a Self

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

🔬 This is a nightly-only experimental API. (clamp)

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.

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

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

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

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

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

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

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

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

impl<T> StructuralEq for QsQuery<T>

impl<T> StructuralPartialEq for QsQuery<T>