Struct axum_extra::extract::Query

pub struct Query<T>(pub T);

Available on crate feature query only.

Extractor that deserializes query strings into some type.

T is expected to implement serde::Deserialize.

Differences from axum::extract::Form

This extractor uses serde_html_form under-the-hood which supports multi-value items. These are sent by multiple <input> attributes of the same name (e.g. checkboxes) and <select>s with the multiple attribute. Those values can be collected into a Vec or other sequential container.

Example

use axum::{routing::get, Router};
use axum_extra::extract::Query;
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 example.

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Query<T>

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> Debug for Query<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Query<T>

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) -> &Self::Target

Dereferences the value.

impl<T, B> FromRequest<B> for Query<T> where
    T: DeserializeOwned,
    B: Send, 

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.

fn from_request<'life0, 'async_trait>(
    req: &'life0 mut RequestParts<B>
) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Perform the extraction.

impl<T: Copy> Copy for Query<T>