pub struct Query<T>(pub T);
Available on crate feature
query
only.Expand description
Extractor that deserializes query strings into some type.
T
is expected to implement serde::Deserialize
.
Example
use axum::{
extract::Query,
routing::get,
Router,
};
use serde::Deserialize;
#[derive(Deserialize)]
struct Pagination {
page: usize,
per_page: usize,
}
// This will parse query strings like `?page=2&per_page=30` into `Pagination`
// structs.
async fn list_things(pagination: Query<Pagination>) {
let pagination: Pagination = pagination.0;
// ...
}
let app = Router::new().route("/list_things", get(list_things));
If the query string cannot be parsed it will reject the request with a 422 Unprocessable Entity
response.
For handling values being empty vs missing see the query-params-with-empty-strings example.
Tuple Fields§
§0: T
Trait Implementations§
source§impl<T, S> FromRequestParts<S> for Query<T>where
T: DeserializeOwned,
S: Send + Sync,
impl<T, S> FromRequestParts<S> for Query<T>where
T: DeserializeOwned,
S: Send + Sync,
§type Rejection = QueryRejection
type Rejection = QueryRejection
If the extractor fails it’ll use this “rejection” type. A rejection is
a kind of error that can be converted into a response.
impl<T: Copy> Copy 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§
source§impl<S, B, T> FromRequest<S, B, ViaParts> for Twhere
B: Send + 'static,
S: Send + Sync,
T: FromRequestParts<S>,
impl<S, B, T> FromRequest<S, B, ViaParts> for Twhere
B: Send + 'static,
S: Send + Sync,
T: FromRequestParts<S>,
§type Rejection = <T as FromRequestParts<S>>::Rejection
type Rejection = <T as FromRequestParts<S>>::Rejection
If the extractor fails it’ll use this “rejection” type. A rejection is
a kind of error that can be converted into a response.