Struct Paginator 

pub struct Paginator<T> {
    pub items: Vec<T>,
    pub total: i64,
    pub per_page: u64,
    pub current_page: u64,
    pub last_page: u64,
}

Page-aware paginator. Produced by QueryBuilder::paginate(per_page, page, pool).

Fields

items: Vec<T>

The rows on the current page.

total: i64

Total row count across all pages (a COUNT(*) against the same query).

per_page: u64

Rows per page.

current_page: u64

1-indexed current page.

last_page: u64

1-indexed last page (computed from total + per_page).

Implementations

impl<T> Paginator<T>

pub fn new( items: Vec<T>, total: i64, per_page: u64, current_page: u64, ) -> Paginator<T>

Build a paginator from a fetched page + the global count.

pub fn has_more_pages(&self) -> bool

pub fn has_previous_pages(&self) -> bool

pub fn next_page(&self) -> Option<u64>

pub fn previous_page(&self) -> Option<u64>

pub fn count(&self) -> usize

Number of items on the current page.

pub fn from(&self) -> Option<u64>

from and to are 1-indexed row positions within the full result set.

pub fn to(&self) -> Option<u64>

pub fn is_empty(&self) -> bool

pub fn map<U, F>(self, f: F) -> Paginator<U>

where F: FnMut(T) -> U,

Map items via a function while keeping the pagination metadata.

Trait Implementations

impl<T> Clone for Paginator<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Paginator<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Serialize for Paginator<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.