Struct actix_web_lab::extract::Query
source · [−]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.
Differences From actix_web::web::Query
This extractor uses serde_html_form
under-the-hood which supports multi-value items. These are
sent by HTML select inputs when multiple options are chosen and can be collected into a Vec
.
This version also removes the custom error handler config; users should instead prefer to handle
errors using the explicit Result<Query<T>, E>
extractor in their handlers.
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, Responder};
use actix_web_lab::extract::Query;
use serde::Deserialize;
#[derive(Debug, Deserialize)]
#[serde(rename_all = "lowercase")]
enum LogType {
Reports,
Actions,
}
#[derive(Debug, Deserialize)]
pub struct LogsParams {
#[serde(rename = "type")]
log_type: u64,
#[serde(rename = "user")]
users: Vec<String>,
}
// Deserialize `LogsParams` 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 `/logs?type=reports&user=foo&user=bar"`.
#[get("/logs")]
async fn index(info: Query<LogsParams>) -> impl Responder {
let LogsParams { log_type, users } = info.into_inner();
format!("Logs request for type={log_type} and user list={users:?}!")
}
// Or use destructuring, which is equivalent to `.into_inner()`.
#[get("/debug2")]
async fn debug2(Query(info): Query<LogsParams>) -> impl Responder {
dbg!("Authorization object = {info:?}");
"OK"
}
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>
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl<T: PartialEq> PartialEq<Query<T>> for Query<T>
impl<T: PartialEq> PartialEq<Query<T>> 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 Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T, A> DynAccess<T> for Awhere
A: Access<T>,
<A as Access<T>>::Guard: 'static,
impl<T, A> DynAccess<T> for Awhere
A: Access<T>,
<A as Access<T>>::Guard: 'static,
sourcefn load(&self) -> DynGuard<T>
fn load(&self) -> DynGuard<T>
The equivalent of Access::load
.
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
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 Twhere
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
impl<T, P> Resource for Twhere
T: DerefMut<Target = Path<P>>,
P: ResourcePath,
impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,
impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,
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