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

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

    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, 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: PartialOrd> PartialOrd<Query<T>> for Query<T>`

[src]

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

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

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

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

[src]

####

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

[src]

This method returns an `Ordering` between `self` and `other`. Read more

####

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

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

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

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

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

[src]

###

`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

###

`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> Deref for Query<T>`

[src]

#### `type Target = T`

The resulting type after dereferencing.

####

`fn deref(&self) -> &T`

[src]

Dereferences the value.

###

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

[src]

####

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

[src]

Mutably dereferences the value.

## Auto Trait Implementations

###

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

###

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

## Blanket Implementations

###

`impl<T> ToString for T where T: Display + ?Sized,`

[src]

####

`fn to_string(&self) -> String`

[src]

Converts the given value to a `String`. Read more

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

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

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

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

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

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

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

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

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

Performs the conversion.

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

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

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

###

`impl<Q, K> Equivalent for Q where K: Borrow<Q> + ?Sized, Q: Eq + ?Sized,`

[src]

####

`fn equivalent(&self, key: &K) -> bool`

[src]

Compare self to `key` and return `true` if they are equal.

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