QueryParams

Struct QueryParams 

Source
pub struct QueryParams {
    pub page: usize,
    pub limit: usize,
    pub filter: Option<String>,
    pub sort: Option<String>,
}
Expand description

Query parameters for pagination and filtering

This structure is used to extract pagination and filtering parameters from URL query strings. All parameters have sensible defaults.

§Example

// In handler:
pub async fn list_items(
    Query(params): Query<QueryParams>,
) -> Json<PaginatedResponse<Item>> {
    // params.page defaults to 1
    // params.limit defaults to 20
}

// Usage:
GET /items?page=2&limit=10
GET /items?filter={"status": "active"}
GET /items?page=1&limit=20&filter={"amount>": 100}&sort=created_at:desc

Fields§

§page: usize

Page number (starts at 1)

§limit: usize

Number of items per page

§filter: Option<String>

Filters as JSON object

§Format

  • Exact match: {"field": "value"}
  • Comparison: {"field>": value, "field<": value, "field>=": value, "field<=": value}

§Example

filter={"status": "active", "amount>": 100, "customer_name": "Acme"}
§sort: Option<String>

Sort field and direction

§Format

  • field:asc or field (ascending)
  • field:desc (descending)

§Example

sort=amount:desc
sort=created_at:asc

Implementations§

Source§

impl QueryParams

Source

pub fn page(&self) -> usize

Get page number, ensuring minimum of 1

Source

pub fn limit(&self) -> usize

Get limit, ensuring it doesn’t exceed the maximum

Source

pub fn filter_value(&self) -> Option<Value>

Parse filter JSON string into Value

Trait Implementations§

Source§

impl Clone for QueryParams

Source§

fn clone(&self) -> QueryParams

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 QueryParams

Source§

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

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

impl Default for QueryParams

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for QueryParams

Source§

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

Deserialize this value from the given Serde deserializer. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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<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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,