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§
source§impl<T> Query<T>
impl<T> Query<T>
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Unwrap into inner T
value.
source§impl<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§
source§impl<T: DeserializeOwned> FromRequest for Query<T>
impl<T: DeserializeOwned> FromRequest for Query<T>
See here for example of usage as an extractor.
source§fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
Self
from request parts asynchronously.source§impl<T: Ord> Ord for Query<T>
impl<T: Ord> Ord for Query<T>
source§impl<T: PartialEq> PartialEq for Query<T>
impl<T: PartialEq> PartialEq for Query<T>
source§impl<T: PartialOrd> PartialOrd for Query<T>
impl<T: PartialOrd> PartialOrd for Query<T>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl<T: Eq> Eq for Query<T>
impl<T> StructuralPartialEq for Query<T>
Auto Trait Implementations§
impl<T> Freeze for Query<T>where
T: Freeze,
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
source§impl<T, A> DynAccess<T> for A
impl<T, A> DynAccess<T> for A
source§fn load(&self) -> DynGuard<T>
fn load(&self) -> DynGuard<T>
Access::load
.source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more