Struct Cursor 

pub struct Cursor {
    pub fields: Vec<(String, Value)>,
}

A cursor for cursor-based pagination.

Cursors encode the position in a result set as a base64 JSON object. The cursor contains the values of the sort fields for the last item.

Security Note

Cursors use simple base64 encoding, not encryption. The cursor content is easily decoded by clients. This is intentional - cursors are opaque pagination tokens, not security mechanisms.

Do not include sensitive data in cursor fields. Only include the values needed for pagination (e.g., id, created_at).

If you need to prevent cursor tampering, validate cursor values against expected ranges or sign cursors server-side.

Fields

fields: Vec<(String, Value)>

Field values that define the cursor position.

Implementations

impl Cursor

pub fn new() -> Self

Create a new empty cursor.

pub fn field(self, name: impl Into<String>, value: impl Into<Value>) -> Self

Add a field value to the cursor.

pub fn int(self, name: impl Into<String>, value: i64) -> Self

Add an integer field.

pub fn string(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add a string field.

pub fn encode(&self) -> String

Encode the cursor to a base64 string.

Note: This uses simple base64, not encryption. See Cursor security note.

pub fn decode(encoded: &str) -> Result<Self, CursorError>

Decode a cursor from a base64 string.

Returns an error if the cursor exceeds MAX_CURSOR_SIZE (4KB).

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.

impl IntoCursor for Cursor

fn into_cursor(self) -> Option<Cursor>

Convert into an optional cursor. Returns None if the input is invalid or missing.

impl PartialEq for Cursor

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