Struct PageInfo 

pub struct PageInfo {
    pub has_next: bool,
    pub has_prev: bool,
    pub next_cursor: Option<String>,
    pub prev_cursor: Option<String>,
    pub total: Option<u64>,
}

Page information for paginated responses.

Example

let page_info = PageInfo::new(items.len(), limit)
    .with_next_cursor(next_cursor)
    .with_prev_cursor(prev_cursor);

ok!({
    "data": items,
    "page_info": {
        "has_next": page_info.has_next,
        "has_prev": page_info.has_prev,
        "next_cursor": page_info.next_cursor,
        "prev_cursor": page_info.prev_cursor
    }
})

Fields

has_next: bool

Whether there are more items after this page.

has_prev: bool

Whether there are items before this page.

next_cursor: Option<String>

Cursor to fetch the next page.

prev_cursor: Option<String>

Cursor to fetch the previous page.

total: Option<u64>

Total count (if available).

Implementations

impl PageInfo

pub fn new(count: usize, limit: usize) -> Self

Create page info based on returned count vs requested limit.

If count >= limit, assumes there are more items.

pub fn with_has_prev(self, has_prev: bool) -> Self

Set whether there are previous items.

pub fn with_next_cursor(self, cursor: Option<String>) -> Self

Set the next cursor.

pub fn with_prev_cursor(self, cursor: Option<String>) -> Self

Set the previous cursor.

pub fn with_total(self, total: u64) -> Self

Set the total count.

pub fn cursor_from<T, F>(item: Option<&T>, builder: F) -> Option<String>

where F: FnOnce(&T) -> Cursor,

Create cursor from the last item using a builder function.

Trait Implementations

impl Clone for PageInfo

fn clone(&self) -> PageInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageInfo

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

Formats the value using the given formatter.

impl Default for PageInfo

fn default() -> PageInfo

Returns the “default value” for a type.