Struct Query

pub struct Query<T>(pub T);

Extractor that deserializes query strings into some type.

T is expected to implement serde::Deserialize.

Examples

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

impl<T> Query<T>

where T: DeserializeOwned,

pub fn try_from_uri(value: &Uri) -> Result<Query<T>, 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

impl<T> Clone for Query<T>

where T: Clone,

fn clone(&self) -> Query<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Query<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Default for Query<T>

where T: Default,

fn default() -> Query<T>

Returns the “default value” for a type.

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Query<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Query<T>

fn deref_mut(&mut self) -> &mut <Query<T> as Deref>::Target

Mutably dereferences the value.

impl<T, S> FromRequestParts<S> for Query<T>

where T: DeserializeOwned, S: Send + Sync,

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.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Query<T>, <Query<T> as FromRequestParts<S>>::Rejection>

Perform the extraction.

impl<T> Copy for Query<T>

where T: Copy,