# actix_web::Query - Rust
API documentation for the Rust `Query` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Query

# Struct actix_web::Query [−] [src]

    pub struct Query<T>(_);

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>`

[src]

####

`pub fn into_inner(self) -> T`

[src]

Deconstruct to a inner value

## Trait Implementations

###

`impl<T> Deref for Query<T>`

[src]

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut R

### 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`

[src]

Dereferences the value.

###

`impl<T> DerefMut for Query<T>`

[src]

####
ⓘImportant traits for &'a mut R

### 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`

[src]

Mutably dereferences the value.

###

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

[src]

#### `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`

[src]

Convert request to a Self

####

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

[src]

Convert request to a Self Read more

###

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

[src]

####

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

[src]

Formats the value using the given formatter. Read more

###

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

[src]

####

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

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

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

###

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)