Struct actix_web::web::Query [−][src]
Extract typed information from the request’s query.
To extract typed data from the URL query string, the inner type T
must implement the
serde::Deserialize
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 `.0`, which is equivalent to `.into_inner()`. #[get("/debug2")] async fn debug2(info: web::Query<AuthRequest>) -> String { dbg!("Authorization object={:?}", info.0); "OK".to_string() }
Implementations
impl<T> Query<T>
[src]
pub fn into_inner(self) -> T
[src]
Unwrap into inner T
value.
pub fn from_query(query_str: &str) -> Result<Self, QueryPayloadError> where
T: DeserializeOwned,
[src]
T: DeserializeOwned,
Deserialize T
from a 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: Clone> Clone for Query<T>
[src]
impl<T: Debug> Debug for Query<T>
[src]
impl<T> Deref for Query<T>
[src]
impl<T> DerefMut for Query<T>
[src]
impl<T: Display> Display for Query<T>
[src]
impl<T: Eq> Eq for Query<T>
[src]
impl<T> FromRequest for Query<T> where
T: DeserializeOwned,
[src]
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<Self, Error>>
Future that resolves to a Self.
type Config = QueryConfig
Configuration for this extractor.
fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
[src]
fn extract(req: &HttpRequest) -> Self::Future
[src]
fn configure<F>(f: F) -> Self::Config where
F: FnOnce(Self::Config) -> Self::Config,
[src]
F: FnOnce(Self::Config) -> Self::Config,
impl<T: Ord> Ord for Query<T>
[src]
fn cmp(&self, other: &Query<T>) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl<T: PartialEq> PartialEq<Query<T>> for Query<T>
[src]
impl<T: PartialOrd> PartialOrd<Query<T>> for Query<T>
[src]
fn partial_cmp(&self, other: &Query<T>) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T> StructuralEq for Query<T>
[src]
impl<T> StructuralPartialEq for Query<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Query<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Query<T> where
T: Send,
T: Send,
impl<T> Sync for Query<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Query<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Query<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,