pub struct Query<T>(pub T);
Expand description
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
sourceimpl<T> Query<T>
impl<T> Query<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Unwrap into inner T
value.
sourceimpl<T: DeserializeOwned> Query<T>
impl<T: DeserializeOwned> Query<T>
sourcepub fn from_query(query_str: &str) -> Result<Self, QueryPayloadError>
pub fn from_query(query_str: &str) -> Result<Self, 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
sourceimpl<T: DeserializeOwned> FromRequest for Query<T>
impl<T: DeserializeOwned> FromRequest for Query<T>
See here for example of usage as an extractor.
sourcefn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
Create a Self from request parts asynchronously.
sourcefn extract(req: &HttpRequest) -> Self::Future
fn extract(req: &HttpRequest) -> Self::Future
Create a Self from request head asynchronously. Read more
sourceimpl<T: Ord> Ord for Query<T>
impl<T: Ord> Ord for Query<T>
sourceimpl<T: PartialOrd> PartialOrd<Query<T>> for Query<T>
impl<T: PartialOrd> PartialOrd<Query<T>> for Query<T>
sourcefn partial_cmp(&self, other: &Query<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &Query<T>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<T: Eq> Eq for Query<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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T, P> Resource for T where
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
impl<T, P> Resource for T where
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more