Struct Query

pub struct Query<T>(pub T);

Extract typed information from the request’s query.

To extract typed data from the URL query string, the inner type T must implement the DeserializeOwned trait.

Use QueryConfig to configure extraction process.

Panics

A query string consists of unordered key=value pairs, therefore it cannot be decoded into any type which depends upon data ordering (eg. tuples). Trying to do so will result in a panic.

Examples

use actix_web::{get, web};
use serde::Deserialize;

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

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

// Deserialize `AuthRequest` struct from query string.
// This handler gets called only if the request's query parameters contain both fields.
// A valid request path for this handler would be `/?id=64&response_type=Code"`.
#[get("/")]
async fn index(info: web::Query<AuthRequest>) -> String {
    format!("Authorization request for id={} and type={:?}!", info.id, info.response_type)
}

// To access the entire underlying query struct, use `.into_inner()`.
#[get("/debug1")]
async fn debug1(info: web::Query<AuthRequest>) -> String {
    dbg!("Authorization object = {:?}", info.into_inner());
    "OK".to_string()
}

// Or use destructuring, which is equivalent to `.into_inner()`.
#[get("/debug2")]
async fn debug2(web::Query(info): web::Query<AuthRequest>) -> String {
    dbg!("Authorization object = {:?}", info);
    "OK".to_string()
}

Tuple Fields

0: T

Implementations

impl<T> Query<T>

pub fn into_inner(self) -> T

Unwrap into inner T value.

impl<T> Query<T>

where T: DeserializeOwned,

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

Deserialize a T from the URL encoded query parameter string.

let numbers = Query::<HashMap<String, u32>>::from_query("one=1&two=2").unwrap();
assert_eq!(numbers.get("one"), Some(&1));
assert_eq!(numbers.get("two"), Some(&2));
assert!(numbers.get("three").is_none());

Trait Implementations

impl<T> Apiv2Schema for Query<T>

where T: Apiv2Schema,

fn name() -> Option<String>

Name of this schema. This is the name to which the definition of the object is mapped.

fn description() -> &'static str

Description of this schema. In case the trait is derived, uses the documentation on the type.

fn required() -> bool

Indicates the requirement of this schema.

fn raw_schema() -> DefaultSchemaRaw

Returns the raw schema for this object.

fn schema_with_ref() -> DefaultSchemaRaw

Returns the schema with a reference (if this is an object).

fn security_scheme() -> Option<SecurityScheme>

Returns the security scheme for this object.

fn header_parameter_schema() -> Vec<Parameter<DefaultSchemaRaw>>

impl<T> Clone for Query<T>

where T: Clone,

fn clone(&self) -> Query<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Query<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Query<T>

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

Mutably dereferences the value.

impl<T> Display for Query<T>

where T: Display,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> FromRequest for Query<T>

where T: DeserializeOwned,

See here for example of usage as an extractor.

type Error = Error

The associated error which can be returned.

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

Future that resolves to a Self.

fn from_request( req: &HttpRequest, _: &mut Payload, ) -> <Query<T> as FromRequest>::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

impl<T> OperationModifier for Query<T>

where T: Apiv2Schema,

fn update_parameter( op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the parameters list in the given operation (if needed).

fn update_definitions(_map: &mut BTreeMap<String, DefaultSchemaRaw>)

Update the definitions map (if needed).

fn update_response( _op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the responses map in the given operation (if needed).

fn update_security( op: &mut Operation<Parameter<DefaultSchemaRaw>, Response<DefaultSchemaRaw>>, )

Update the security map in the given operation (if needed).

fn update_security_definitions(map: &mut BTreeMap<String, SecurityScheme>)

Update the security definition map (if needed).

impl<T> Ord for Query<T>

where T: Ord,

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Query<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for Query<T>

where T: PartialOrd,

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T> Eq for Query<T>

where T: Eq,

impl<T> StructuralPartialEq for Query<T>