pub struct Query<T>(pub T);
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 400 Bad Request
response.
For handling values being empty vs missing see the query-params-with-empty-strings example.
For handling multiple values for the same query parameter, in a ?foo=1&foo=2&foo=3
fashion, use axum_extra::extract::Query
instead.
Tuple Fields§
§0: T
Implementations§
source§impl<T> Query<T>where
T: DeserializeOwned,
impl<T> Query<T>where
T: DeserializeOwned,
sourcepub fn try_from_uri(value: &Uri) -> Result<Self, QueryRejection>
pub fn try_from_uri(value: &Uri) -> Result<Self, QueryRejection>
Attempts to construct a Query
from a reference to a Uri
.
§Example
use axum::extract::Query;
use http::Uri;
use serde::Deserialize;
#[derive(Deserialize)]
struct ExampleParams {
foo: String,
bar: u32,
}
let uri: Uri = "http://example.com/path?foo=hello&bar=42".parse().unwrap();
let result: Query<ExampleParams> = Query::try_from_uri(&uri).unwrap();
assert_eq!(result.foo, String::from("hello"));
assert_eq!(result.bar, 42);
Trait Implementations§
source§impl<T, S> FromRequestParts<S> for Query<T>
impl<T, S> FromRequestParts<S> for Query<T>
source§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> 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
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<S, T> FromRequest<S, ViaParts> for T
impl<S, T> FromRequest<S, ViaParts> for T
source§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.