Struct Cursor 

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

An opaque keyset continuation token.

The encoding is not a documented format and confers no authority. A token presented to a different query, different filters, or a different page size is rejected rather than reinterpreted.

Implementations

impl Cursor

pub fn from_bytes(value: impl Into<Vec<u8>>) -> Result<Self, CursorError>

Reconstructs a cursor from its opaque bytes.

Errors

Returns CursorError::CursorInvalid when the token is empty or exceeds MAX_CURSOR_BYTES.

pub fn from_hex(value: &str) -> Result<Self, CursorError>

Reconstructs a cursor from its lowercase hexadecimal text form.

Errors

Returns CursorError::CursorInvalid when the text is not an even number of hexadecimal digits within the token bound.

pub fn as_bytes(&self) -> &[u8]

Returns the opaque token bytes.

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Cursor

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

Formats the value using the given formatter.

impl Eq for Cursor

impl Hash for Cursor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Cursor

fn cmp(&self, other: &Cursor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Cursor

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Cursor

fn partial_cmp(&self, other: &Cursor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Cursor