Struct CursorPagination

pub struct CursorPagination {
    pub cursor: Option<String>,
    pub limit: u32,
    pub include_cursor: bool,
    pub has_next: bool,
    pub has_prev: bool,
    pub next_cursor: Option<String>,
    pub prev_cursor: Option<String>,
    pub total: Option<u64>,
}

Cursor-based pagination for better performance with large datasets

Cursor-based pagination uses a cursor (typically a timestamp or ID) to mark the position in the dataset, providing consistent results even when data is being added or removed during pagination.

Advantages

• Consistent results: No duplicate or missing items when data changes
• Better performance: No need to count total items or skip large offsets
• Real-time friendly: Works well with live data streams

Examples

use libsql_orm::CursorPagination;

// First page
let pagination = CursorPagination::new(10);

// Subsequent pages using cursor from previous result
let next_pagination = CursorPagination::with_cursor(10, Some("cursor_value".to_string()));

Fields

cursor: Option<String>

Cursor for the next page

limit: u32

Number of items per page

include_cursor: bool

Whether to include the cursor item in results

has_next: bool

Whether there are more items

has_prev: bool

Whether there are previous items

next_cursor: Option<String>

Cursor for the next page

prev_cursor: Option<String>

Cursor for the previous page

total: Option<u64>

Total number of items

Implementations

impl CursorPagination

pub fn new(limit: u32) -> Self

Create a new cursor pagination instance

pub fn with_cursor(limit: u32, cursor: Option<String>) -> Self

Create with a specific cursor

pub fn with_cursor_old(cursor: String, limit: u32) -> Self

Create with a specific cursor (deprecated, use with_cursor(limit, cursor) instead)

pub fn set_cursor(&mut self, cursor: Option<String>)

Set the cursor

pub fn limit(&self) -> u32

Get the limit for SQL queries

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 Default for CursorPagination

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CursorPagination

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CursorPagination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.