Struct CursorParams 

pub struct CursorParams {
    pub direction: Option<CursorDirection>,
    pub values: Vec<FilterValue>,
    pub error: Option<String>,
}

Internal cursor params with metadata - contains the cursor data plus internal processing metadata

Fields

direction: Option<CursorDirection>

Internal direction metadata

values: Vec<FilterValue>

After, Before, and decoded cursor data - used when building queries

error: Option<String>

Optional error message if cursor processing failed

Implementations

impl CursorParams

pub fn new(value: FilterValue, direction: CursorDirection) -> CursorParams

pub fn from_values( values: Vec<FilterValue>, direction: CursorDirection, ) -> CursorParams

pub fn with_error( direction: CursorDirection, error: impl Into<String>, ) -> CursorParams

pub fn and_field(self, value: FilterValue) -> CursorParams

pub fn values(&self) -> &[FilterValue]

Access to the cursor values

pub fn is_empty(&self) -> bool

Check if cursor has values

pub fn len(&self) -> usize

Get the number of values

pub fn has_error(&self) -> bool

Check if this cursor has an error

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

Get the error message if any

pub fn generate_next_cursor<T>( &self, data: &[T], has_next: bool, sorting_params: &SortingParams, ) -> Result<Option<String>, CursorError>

where T: CursorSecureExtract,

Generate next cursor from the last item in data

pub fn generate_prev_cursor<T>( &self, data: &[T], has_prev: bool, sorting_params: &SortingParams, ) -> Result<Option<String>, CursorError>

where T: CursorSecureExtract,

Generate prev cursor from the first item in data

Trait Implementations

impl Clone for CursorParams

fn clone(&self) -> CursorParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CursorParams

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

Formats the value using the given formatter.

impl Default for CursorParams

fn default() -> CursorParams

Returns the “default value” for a type.

impl IntoParams for CursorParams

fn into_params(self) -> Params

impl PartialEq for CursorParams

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