KeysetCondition

Struct KeysetCondition 

Source
#[non_exhaustive]
pub struct KeysetCondition { pub sort_fields: Vec<SortField>, pub cursor_values: Vec<Value>, pub forward: bool, }
Expand description

Keyset pagination condition.

Generates efficient (col1, col2) > ($1, $2) style WHERE clauses for keyset/seek pagination.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§sort_fields: Vec<SortField>

The sort fields and their directions.

§cursor_values: Vec<Value>

The cursor values for each field.

§forward: bool

Direction: true for “after”, false for “before”.

Implementations§

Source§

impl KeysetCondition

Source

pub fn after(sorts: &[SortField], cursor: &Cursor) -> Option<Self>

Create a new keyset condition for paginating after a cursor.

Source

pub fn before(sorts: &[SortField], cursor: &Cursor) -> Option<Self>

Create a new keyset condition for paginating before a cursor.

Source

pub fn to_filter_expr(&self) -> FilterExpr

Convert to a filter expression for the query builder.

For a single field, generates: field > $1 (or < for DESC)

For multiple fields, generates proper compound OR conditions: (a, b) > (1, 2) becomes: (a > 1) OR (a = 1 AND b > 2)

For 3+ fields: (a > 1) OR (a = 1 AND b > 2) OR (a = 1 AND b = 2 AND c > 3)

This follows the keyset pagination standard used by PostgreSQL, GraphQL Relay, and major ORMs. See: https://use-the-index-luke.com/no-offset

Trait Implementations§

Source§

impl Clone for KeysetCondition

Source§

fn clone(&self) -> KeysetCondition

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeysetCondition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for KeysetCondition

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for KeysetCondition

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.