Struct CursorPaginate 

pub struct CursorPaginate {
    pub cursor: Option<String>,
    pub per_page: u64,
}

Cursor-based pagination extractor

Extracts cursor pagination parameters from the query string. Supports ?cursor=abc123&limit=20 (defaults: cursor=None, limit=20, max=100).

Cursor-based pagination is preferred for large datasets or real-time data where offset-based pagination would skip or duplicate items.

Example

use rustapi_core::CursorPaginate;

async fn list_events(cursor: CursorPaginate) -> impl IntoResponse {
    let limit = cursor.limit();
    if let Some(after) = cursor.after() {
        // SELECT * FROM events WHERE id > $after ORDER BY id LIMIT $limit
    } else {
        // SELECT * FROM events ORDER BY id LIMIT $limit
    }
}

Fields

cursor: Option<String>

Opaque cursor token (None = start from beginning)

per_page: u64

Items per page (capped at MAX_PER_PAGE)

Implementations

impl CursorPaginate

pub fn new(cursor: Option<String>, per_page: u64) -> Self

Create a new CursorPaginate

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

Get the cursor value (if any)

pub fn limit(&self) -> u64

Get the LIMIT value

pub fn is_first_page(&self) -> bool

Check if this is the first page (no cursor)

Trait Implementations

impl Clone for CursorPaginate

fn clone(&self) -> CursorPaginate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CursorPaginate

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

Formats the value using the given formatter.

impl Default for CursorPaginate

fn default() -> Self

Returns the “default value” for a type.

impl FromRequestParts for CursorPaginate

fn from_request_parts(req: &Request) -> Result<Self>

Extract from request parts