Struct CursorPagination 

pub struct CursorPagination {
    pub cursor: Option<String>,
    pub limit: u32,
}

Cursor-based pagination parameters parsed from the query string.

Reads an opaque cursor token (absent on the first page) and a limit that is clamped the same way as Pagination. Requires the extract feature.

Example

use axum_api_kit::{CursorPagination, CursorResponse};
use serde::Serialize;

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

async fn feed(page: CursorPagination) -> CursorResponse<Item> {
    // Decode page.cursor, fetch page.limit + 1 rows, derive the next token...
    let items = vec![Item { id: 1 }];
    page.cursor_response(items, Some("next".into()))
}

Fields

cursor: Option<String>

Opaque cursor token for the requested page. None on the first page.

limit: u32

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

Implementations

impl CursorPagination

pub fn cursor_response<T: Serialize>( &self, data: Vec<T>, next_cursor: Option<String>, ) -> CursorResponse<T>

Build a CursorResponse from this page’s items and the next-page cursor.

has_more is set to next_cursor.is_some().

Trait Implementations

impl Clone for CursorPagination

fn clone(&self) -> CursorPagination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CursorPagination

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

Formats the value using the given formatter.

impl Eq for CursorPagination

impl<S> FromRequestParts<S> for CursorPagination

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 CursorPagination

fn eq(&self, other: &CursorPagination) -> 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 CursorPagination