Struct actix_web::Query

[+] Show declaration

pub struct Query<T>(_);

[−] Expand description

Extract typed information from from the request's query.

Example

#[macro_use] extern crate serde_derive;
use actix_web::{App, Query, http};


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

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

// use `with` extractor for query info
// 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"`
fn index(info: Query<AuthRequest>) -> String {
    format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type)
}

fn main() {
    let app = App::new().resource(
       "/index.html",
       |r| r.method(http::Method::GET).with(index)); // <- use `with` extractor
}

Methods

impl<T> Query<T>

[−]

pub fn into_inner(self) -> T

[−]

Deconstruct to a inner value

Trait Implementations

impl<T> Deref for Query<T>

[+]

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

[−]

Dereferences the value.

impl<T> DerefMut for Query<T>

[+]

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

[−]

Mutably dereferences the value.

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

[+]

type Config = ()

Configuration for conversion process

type Result = Result<Self, Error>

Future that resolves to a Self

fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result

[−]

Convert request to a Self

fn extract(req: &HttpRequest<S>) -> Self::Result

[−]

Convert request to a Self

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

[+]

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

[−]

Formats the value using the given formatter.

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

[+]

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

[−]

Formats the value using the given formatter.