[]Struct paperclip::actix::web::Query

pub struct Query<T>(pub T);

Extract typed information from the request's query.

Note: A query string consists of unordered key=value pairs, therefore it cannot be decoded into any type which depends upon data ordering e.g. tuples or tuple-structs. Attempts to do so will fail at runtime.

QueryConfig allows to configure extraction process.

Example

use actix_web::{web, App};
use serde_derive::Deserialize;

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

#[derive(Deserialize)]
pub struct AuthRequest {
   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 `username` field.
// The correct request for this handler would be `/index.html?id=64&response_type=Code"`.
async fn index(web::Query(info): web::Query<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
}

Methods

impl<T> Query<T>

pub fn into_inner(self) -> T

Deconstruct to a inner value

pub fn from_query(query_str: &str) -> Result<Query<T>, QueryPayloadError> where
    T: DeserializeOwned

Get query parameters from the path

Trait Implementations

impl<T> Apiv2Schema for Query<T> where
    T: Apiv2Schema
[src]

impl<T> Debug for Query<T> where
    T: Debug

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

impl<T> DerefMut for Query<T>

impl<T> Display for Query<T> where
    T: Display

impl<T> Eq for Query<T> where
    T: Eq

impl<T> FromRequest for Query<T> where
    T: DeserializeOwned

Extract typed information from the request's query.

Example

use actix_web::{web, App};
use serde_derive::Deserialize;

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

#[derive(Deserialize)]
pub struct AuthRequest {
   id: u64,
   response_type: ResponseType,
}

// Use `Query` extractor for query information.
// This handler get called only if request's query contains `username` field
// The correct request for this handler would be `/index.html?id=64&response_type=Code"`
async fn index(info: web::Query<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
}

type Error = Error

The associated error which can be returned.

type Future = Ready<Result<Query<T>, Error>>

Future that resolves to a Self

type Config = QueryConfig

Configuration for this extractor

impl<T> OperationModifier for Query<T> where
    T: Apiv2Schema
[src]

impl<T> Ord for Query<T> where
    T: Ord

impl<T> PartialEq<Query<T>> for Query<T> where
    T: PartialEq<T>, 

impl<T> PartialOrd<Query<T>> for Query<T> where
    T: PartialOrd<T>, 

impl<T> StructuralEq for Query<T>

impl<T> StructuralPartialEq for Query<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Query<T> where
    T: RefUnwindSafe

impl<T> Send for Query<T> where
    T: Send

impl<T> Sync for Query<T> where
    T: Sync

impl<T> Unpin for Query<T> where
    T: Unpin

impl<T> UnwindSafe for Query<T> where
    T: UnwindSafe

Blanket Implementations

impl<T, A, P> Access<T> for P where
    A: Access<T>,
    P: Deref<Target = A>, 
[src]

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Apiv2Schema for T where
    T: TypedData
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, A> DynAccess<T> for A where
    A: Access<T>,
    <A as Access<T>>::Guard: 'static, 
[src]

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Err = <U as TryFrom<T>>::Err

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,