Struct KeysetPaginatedResponse 

pub struct KeysetPaginatedResponse<T> {
    pub items: Vec<T>,
    pub has_next: bool,
    pub has_prev: bool,
    pub prev_cursor: Option<String>,
    pub next_cursor: Option<String>,
}

A page of results from a keyset-paginated endpoint.

has_next / has_prev reflect whether further pages exist in each direction. Cursors for navigation are opaque strings — typically the serialised key of the first/last item in items.

Requires std or alloc.

Fields

items: Vec<T>

The items on this page.

has_next: bool

Whether a next page exists (there are items after the last item).

has_prev: bool

Whether a previous page exists (there are items before the first item).

prev_cursor: Option<String>

Opaque cursor pointing to the item just before the first item in items.

Pass this as before to retrieve the previous page.

next_cursor: Option<String>

Opaque cursor pointing to the item just after the last item in items.

Pass this as after to retrieve the next page.

Implementations

impl<T> KeysetPaginatedResponse<T>

pub fn new( items: Vec<T>, has_next: bool, has_prev: bool, prev_cursor: Option<String>, next_cursor: Option<String>, ) -> Self

Create a new keyset-paginated response.

Examples

use api_bones::pagination::KeysetPaginatedResponse;

let resp = KeysetPaginatedResponse::new(
    vec![1i32, 2, 3],
    true,
    false,
    None,
    Some("cursor_after_3".to_string()),
);
assert!(resp.has_next);
assert!(!resp.has_prev);

pub fn first_page( items: Vec<T>, has_next: bool, next_cursor: Option<String>, ) -> Self

Convenience: first page with no previous cursor.

Examples

use api_bones::pagination::KeysetPaginatedResponse;

let resp = KeysetPaginatedResponse::first_page(
    vec!["a", "b", "c"],
    true,
    Some("cursor_after_c".to_string()),
);
assert!(!resp.has_prev);
assert!(resp.has_next);

Trait Implementations

impl<T: Clone> Clone for KeysetPaginatedResponse<T>

fn clone(&self) -> KeysetPaginatedResponse<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for KeysetPaginatedResponse<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for KeysetPaginatedResponse<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for KeysetPaginatedResponse<T>

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

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for KeysetPaginatedResponse<T>