[−][src]Struct actix_web_validator::Query
Extract and validate typed information from the request's query.
For query decoding uses serde_urlencoded crate QueryConfig allows to configure extraction process.
Example
use actix_web::{web, App}; use serde_derive::Deserialize; use actix_web_validator::Query; use validator::Validate; #[derive(Debug, Deserialize)] pub enum ResponseType { Token, Code } #[derive(Deserialize, Validate)] pub struct AuthRequest { #[validate(range(min = 1000, max = 9999))] id: u64, response_type: ResponseType, } // Use `Query` extractor for query information (and destructure it within the signature). // This handler gets called only if the request's query string contains a `id` and // `response_type` fields. // The correct request for this handler would be `/index.html?id=1234&response_type=Code"`. async fn index(info: Query<AuthRequest>) -> String { format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type) } fn main() { let app = App::new().service( web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor }
Implementations
impl<T> Query<T> where
T: Validate,
[src]
T: Validate,
pub fn into_inner(self) -> T
[src]
Deconstruct to an inner value.
Trait Implementations
impl<T> AsRef<T> 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 + Validate,
[src]
T: DeserializeOwned + Validate,
Extract typed information from the request's query.
Example
use actix_web::{web, App}; use serde_derive::Deserialize; use actix_web_validator::Query; use validator::Validate; #[derive(Debug, Deserialize)] pub enum ResponseType { Token, Code } #[derive(Deserialize, Validate)] pub struct AuthRequest { #[validate(range(min = 1000, max = 9999))] id: u64, response_type: ResponseType, } // Use `Query` extractor for query information (and destructure it within the signature). // This handler gets called only if the request's query string contains a `id` and // `response_type` fields. // The correct request for this handler would be `/index.html?id=19&response_type=Code"`. async fn index(web::Query(info): web::Query<AuthRequest>) -> String { format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type) } fn main() { let app = App::new().service( web::resource("/index.html").route(web::get().to(index))); // <- use `Query` extractor }
type Error = Error
The associated error which can be returned.
type Future = Ready<Result<Self, Self::Error>>
Future that resolves to a Self
type Config = QueryConfig
Configuration for this extractor
pub fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future
[src]
Builds Query struct from request and provides validation mechanism
pub fn extract(req: &HttpRequest) -> Self::Future
[src]
pub 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]
pub 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]
pub fn partial_cmp(&self, other: &Query<T>) -> Option<Ordering>
[src]
pub fn lt(&self, other: &Query<T>) -> bool
[src]
pub fn le(&self, other: &Query<T>) -> bool
[src]
pub fn gt(&self, other: &Query<T>) -> bool
[src]
pub fn ge(&self, other: &Query<T>) -> bool
[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,
[src]
T: RefUnwindSafe,
impl<T> Send for Query<T> where
T: Send,
[src]
T: Send,
impl<T> Sync for Query<T> where
T: Sync,
[src]
T: Sync,
impl<T> Unpin for Query<T> where
T: Unpin,
[src]
T: Unpin,
impl<T> UnwindSafe for Query<T> where
T: UnwindSafe,
[src]
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> 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> 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>,