Struct Cursor 

pub struct Cursor(/* private fields */);

An opaque keyset cursor bound to a version and to the request filters.

Encode with Cursor::encode and read the position back with Cursor::page_key. The wire form is base64url without padding and must be treated as opaque by clients.

Implementations

impl Cursor

pub fn from_page_key<F>( key: &PageKey<String>, normalized_filters: &F, ) -> Result<Self, PaginationError>

where F: Serialize + ?Sized,

Builds a cursor for a keyset position and the filters it belongs to.

normalized_filters must serialize deterministically. Use a struct with a fixed field order or a BTreeMap, and normalize values (case, default ranges) before hashing so an equivalent request keeps its cursor valid.

Errors

Returns PaginationError::InvalidCursor if the filters cannot be serialized to JSON.

pub fn decode<F>( encoded: &str, normalized_filters: &F, ) -> Result<Self, PaginationError>

where F: Serialize + ?Sized,

Decodes a client cursor and checks it against the current filters.

Errors

Returns PaginationError::InvalidCursor when the input is not base64url, is not the expected payload, carries a version this build does not understand, or was issued for a different filter set.

pub fn encode(&self) -> Result<String, PaginationError>

Renders the cursor as the base64url string sent to clients.

Errors

Returns PaginationError::InvalidCursor if the payload cannot be serialized.

pub fn page_key<T>(&self) -> Result<PageKey<T>, PaginationError>

where T: FromStr,

Parses the keyset position back into the ordered column type.

Errors

Returns PaginationError::InvalidCursor when the stored value does not parse as T or the tie-breaker is not a UUID.

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 Eq for Cursor

impl PartialEq for Cursor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Cursor