Struct KeysetPaginationParams 

pub struct KeysetPaginationParams<K> {
    pub after: Option<K>,
    pub before: Option<K>,
    pub limit: Option<u64>,
}

Query parameters for keyset (seek-based) pagination.

Keyset pagination is more efficient than offset pagination for large datasets because the database anchors the query on an indexed column value rather than skipping rows.

• after — fetch items whose sort key is greater than this value
• before — fetch items whose sort key is less than this value
• limit — maximum number of items to return (1–100, default 20)

Typically only one of after / before is supplied per request.

Requires std or alloc.

Fields

after: Option<K>

Fetch items after (exclusive) this key value.

before: Option<K>

Fetch items before (exclusive) this key value.

limit: Option<u64>

Maximum number of items to return (1–100). Defaults to 20.

Implementations

impl<K> KeysetPaginationParams<K>

pub fn new( limit: u64, after: Option<K>, before: Option<K>, ) -> Result<Self, ValidationError>

Create validated keyset pagination params.

Returns Err if limit is outside 1–100.

Examples

use api_bones::pagination::KeysetPaginationParams;

let p = KeysetPaginationParams::<String>::new(10, None, None).unwrap();
assert_eq!(p.limit(), 10);

assert!(KeysetPaginationParams::<String>::new(0, None, None).is_err());
assert!(KeysetPaginationParams::<String>::new(101, None, None).is_err());

pub fn limit(&self) -> u64

Resolved limit value (falls back to 20).

Examples

use api_bones::pagination::KeysetPaginationParams;

let p = KeysetPaginationParams::<String>::default();
assert_eq!(p.limit(), 20);

Trait Implementations

impl<K: Clone> Clone for KeysetPaginationParams<K>

fn clone(&self) -> KeysetPaginationParams<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for KeysetPaginationParams<K>

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

Formats the value using the given formatter.

impl<K> Default for KeysetPaginationParams<K>

Available on crate features std or alloc only.

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K> Deserialize<'de> for KeysetPaginationParams<K>

where K: Deserialize<'de> + Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K: PartialEq> PartialEq for KeysetPaginationParams<K>

fn eq(&self, other: &KeysetPaginationParams<K>) -> 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<K> Serialize for KeysetPaginationParams<K>

where K: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<K> Validate for KeysetPaginationParams<K>

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a, K> ValidateArgs<'v_a> for KeysetPaginationParams<K>

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl<K: Eq> Eq for KeysetPaginationParams<K>

impl<K> StructuralPartialEq for KeysetPaginationParams<K>