Struct Pagination

pub struct Pagination { /* private fields */ }

Struct representing pagination information.

Examples

let pagination =
    Pagination::new().items_per_page(20).total_items(50).page(1);

let total_pages = pagination.get_total_pages(); // 3

Implementations

impl Pagination

pub const fn new() -> Self

Create a new Pagination.

let pagination = Pagination::new();
// equals to
// let pagination = Pagination {
//     page:           1,
//     total_pages:    1,
//     items_per_page: 0,
//     total_items:    0,
// };

pub const fn page(self, page: usize) -> Self

Set the page number.

• If the value is 0, it will be changed to 1.
• If the value is bigger than total_pages, it will be changed to total_pages.

pub const fn items_per_page(self, items_per_page: usize) -> Self

Number of items per page.

• If the value is 0, it means all items in a single page.

pub const fn total_items(self, total_items: usize) -> Self

Total number of items.

impl Pagination

pub const fn get_page(&self) -> usize

Get the page number.

pub const fn get_total_pages(&self) -> usize

Get the total number of pages.

pub const fn get_items_per_page(&self) -> usize

Number of items per page.

• If the value is 0, it means all items in a single page.

pub const fn get_total_items(&self) -> usize

Get total number of items.

Trait Implementations

impl Clone for Pagination

fn clone(&self) -> Pagination

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pagination

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

Formats the value using the given formatter.

impl Serialize for Pagination

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

where __S: Serializer,

Serialize this value into the given Serde serializer.