Struct ListQuery 

pub struct ListQuery { /* private fields */ }

Sort/filter parameters parsed from the query string, composing with PageRequest to drive an allowlisted list query.

ListQuery is the request half of the safe sort/filter feature. It parses three families of query parameters, all optional and all best-effort:

Parameter	Meaning	Default
sort	Column key to order by	model’s default order (primary key)
dir	asc or desc	asc (anything unrecognized → asc)
filter[<col>]	Equality filter on column <col>	none

The allowlist is the security boundary

ListQuery itself performs no validation of column names — it only carries the raw request intent. The safety guarantee lives in the repository list() method generated by #[repository]: that method matches the requested sort/filter[..] keys against the model’s own columns using Diesel’s typed DSL. A key that is not a real column hits the default match arm and is silently ignored — it can never be interpolated into SQL. This is why an attacker-supplied ?sort=id;DROP TABLE users is inert: id;DROP TABLE users is not a column, so it falls through to the model’s default ordering.

Because the extractor is Infallible it never rejects a request: an empty sort falls back to the default order, an invalid dir falls back to asc, and unknown parameters are dropped — mirroring PageRequest’s forgiving posture.

Example

use autumn_web::prelude::*;
use autumn_web::pagination::{ListQuery, PageRequest};

// GET /posts?sort=title&dir=desc&filter[published]=true&page=2
#[get("/posts")]
async fn index(
    list_query: ListQuery,
    page_req: PageRequest,
    repo: PgPostRepository,
) -> AutumnResult<Json<Page<Post>>> {
    // `list()` applies only allowlisted columns; unknown keys are ignored.
    let page = repo.list(&list_query, &page_req).await?;
    Ok(Json(page))
}

Implementations

impl ListQuery

pub fn new(sort: Option<&str>, dir: SortDir, filters: &[(&str, &str)]) -> Self

Construct a ListQuery explicitly. Useful in tests and when driving list() from code rather than a request.

pub fn sort(&self) -> Option<&str>

The requested sort column key, if any.

This is the raw requested key — it may name a column that is not in the model’s allowlist, in which case list() ignores it and falls back to the default order. Returns None when no (or an empty) sort= was provided.

pub const fn direction(&self) -> SortDir

The resolved sort direction, defaulting to SortDir::Asc.

pub fn filters(&self) -> impl Iterator<Item = (&str, &str)>

Iterate over the requested equality filters as (column, value) pairs.

As with sort, these are raw requested keys: list() applies only the ones that name a real, filterable column and silently drops the rest.

pub fn is_empty(&self) -> bool

true when no sort, direction override, or filters were requested.

Trait Implementations

impl Clone for ListQuery

fn clone(&self) -> ListQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListQuery

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

Formats the value using the given formatter.

impl Default for ListQuery

fn default() -> ListQuery

Returns the “default value” for a type.

impl<S> FromRequestParts<S> for ListQuery

where S: Send + Sync,

type Rejection = Infallible

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<Self, Self::Rejection>

Perform the extraction.