Struct Pagination 

pub struct Pagination {
    pub limit: u32,
    pub offset: u32,
}

Offset/limit pagination parameters parsed from the query string.

Reads the limit and offset query parameters. A missing limit falls back to Pagination::DEFAULT_LIMIT and a missing offset to 0. limit is clamped to 1..=Pagination::MAX_LIMIT. A non-numeric value rejects the request with a 400 Bad Request carrying code INVALID_QUERY.

Requires the extract feature.

Example

use axum_api_kit::{ListResponse, Pagination};
use serde::Serialize;

#[derive(Serialize)]
struct Item {
    id: u64,
}

async fn list(page: Pagination) -> ListResponse<Item> {
    // Query your store using page.limit / page.offset...
    let items = vec![Item { id: 1 }];
    page.list_response(items, 1)
}

Fields

limit: u32

Maximum number of items to return (clamped to 1..=Pagination::MAX_LIMIT).

offset: u32

Zero-based offset of the first item in the page.

Implementations

impl Pagination

pub const DEFAULT_LIMIT: u32 = 50

Page size used when the limit query parameter is absent.

pub const MAX_LIMIT: u32 = 100

Largest page size accepted; larger requests are clamped down to this value.

pub fn list_response<T: Serialize>( &self, data: Vec<T>, total: i64, ) -> ListResponse<T>

Build a ListResponse for this page from its items and the total match count.

Trait Implementations

impl Clone for Pagination

fn clone(&self) -> Pagination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Pagination

impl Debug for Pagination

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

Formats the value using the given formatter.

impl Eq for Pagination

impl<S> FromRequestParts<S> for Pagination

where S: Send + Sync,

type Rejection = (StatusCode, Json<ApiError>)

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.

impl PartialEq for Pagination

fn eq(&self, other: &Pagination) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Pagination