Struct QueryString

pub struct QueryString<T>(pub T);

Axum’s Query extractor, modified to use serde-querystring.

T is expected to implement serde::Deserialize.

Example

use axum::{
    routing::get,
    Router,
};
use serde::Deserialize;
use serde_querystring_axum::QueryString;

#[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: QueryString<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.

To change the default error and the parsing mode, add QueryStringConfig to your extensions.

use axum::{Router, Extension, http::StatusCode};
use serde_querystring_axum::{ParseMode, QueryStringConfig};

let app = Router::new().layer(Extension(
    QueryStringConfig::new(ParseMode::Brackets).ehandler(|err| {
        (StatusCode::BAD_REQUEST, err.to_string()) // return type should impl IntoResponse
    }),
));

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for QueryString<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for QueryString<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for QueryString<T>

fn default() -> QueryString<T>

Returns the “default value” for a type.

impl<T> Deref for QueryString<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

where T: DeserializeOwned, S: Send + Sync,

type Rejection = Response<UnsyncBoxBody<Bytes, Error>>

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_parts<'life0, 'life1, 'async_trait>( parts: &'life0 mut Parts, _state: &'life1 S, ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform the extraction.

impl<T: Copy> Copy for QueryString<T>