Skip to main content

FlatQueryParams

Struct FlatQueryParams 

Source
pub struct FlatQueryParams {
    pub pagination: Option<QueryPaginationParams>,
    pub sort: Option<QuerySortParams>,
    pub search: Option<QuerySearchParams>,
    pub date_range: Option<QueryDateRangeParams>,
    pub filters: Option<HashMap<String, QueryFilterCondition>>,
}
Expand description

Flattened query parameters suitable for deserializing from HTTP query strings.

This struct is designed to work with web frameworks’ query string deserializers. All fields are optional to allow partial parameter specification.

§Filter Syntax

Supports both simple equality and advanced operator syntax:

  • Simple: field=value → Equal operator
  • With operator: field[op]=value → Specified operator

§Examples

use sqlx_paginated::FlatQueryParams;
use serde::Deserialize;

// Simple equality filters:
// ?status=active&role=admin

// Advanced operator filters:
// ?price[gt]=10&stock[lte]=100&status[ne]=deleted
// ?role[in]=admin,moderator&deleted_at[is_null]=

// With Actix-web:
// async fn handler(Query(params): Query<FlatQueryParams>) { ... }

// With Axum:
// async fn handler(Query(params): Query<FlatQueryParams>) { ... }

Fields§

§pagination: Option<QueryPaginationParams>

Pagination parameters (page, page_size)

§sort: Option<QuerySortParams>

Sort parameters (sort_column, sort_direction)

§search: Option<QuerySearchParams>

Search parameters (search, search_columns)

§date_range: Option<QueryDateRangeParams>

Date range parameters (date_column, date_after, date_before)

§filters: Option<HashMap<String, QueryFilterCondition>>

Filter conditions with operators

Supports operator syntax in query strings:

  • field=value → Equality
  • field[gt]=value → Greater than
  • field[in]=val1,val2 → In list
  • field[is_null]= → Is null

See QueryFilterOperator for all supported operators.

Trait Implementations§

Source§

impl Clone for FlatQueryParams

Source§

fn clone(&self) -> FlatQueryParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlatQueryParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FlatQueryParams

Source§

fn default() -> FlatQueryParams

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for FlatQueryParams

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'q, T> From<FlatQueryParams> for QueryParams<'q, T>

Source§

fn from(params: FlatQueryParams) -> Self

Converts to this type from the input type.
Source§

impl Serialize for FlatQueryParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,