Struct Pagination 

pub struct Pagination {
    pub page: u32,
    pub limit: u32,
    pub pages: u32,
    pub total: u32,
    pub next: Option<u32>,
    pub prev: Option<u32>,
}

Pagination information for browse endpoints.

Contains information about the current page, total number of pages, and links to the next/previous pages.

Fields

• page - Current page number (1-indexed)
• limit - Number of items per page
• pages - Total number of pages available
• total - Total number of items across all pages
• next - Page number of the next page, if available
• prev - Page number of the previous page, if available

Example

use ghost_io_api::models::pagination::Pagination;
use serde_json::json;

let json = json!({
    "page": 2,
    "limit": 10,
    "pages": 5,
    "total": 47,
    "next": 3,
    "prev": 1
});

let pagination: Pagination = serde_json::from_value(json).unwrap();
assert_eq!(pagination.page, 2);
assert!(pagination.has_next());
assert!(pagination.has_prev());
assert!(!pagination.is_first_page());
assert!(!pagination.is_last_page());

Fields

page: u32

Current page number (1-indexed).

limit: u32

Number of items per page.

pages: u32

Total number of pages available.

total: u32

Total number of items across all pages.

next: Option<u32>

Page number of the next page, if available.

None if this is the last page.

prev: Option<u32>

Page number of the previous page, if available.

None if this is the first page.

Implementations

impl Pagination

pub fn has_next(&self) -> bool

Returns true if there is a next page available.

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 1,
    limit: 15,
    pages: 5,
    total: 73,
    next: Some(2),
    prev: None,
};

assert!(pagination.has_next());

pub fn has_prev(&self) -> bool

Returns true if there is a previous page available.

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 2,
    limit: 15,
    pages: 5,
    total: 73,
    next: Some(3),
    prev: Some(1),
};

assert!(pagination.has_prev());

pub fn is_first_page(&self) -> bool

Returns true if this is the first page.

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 1,
    limit: 15,
    pages: 5,
    total: 73,
    next: Some(2),
    prev: None,
};

assert!(pagination.is_first_page());

pub fn is_last_page(&self) -> bool

Returns true if this is the last page.

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 5,
    limit: 15,
    pages: 5,
    total: 73,
    next: None,
    prev: Some(4),
};

assert!(pagination.is_last_page());

pub fn items_on_page(&self) -> u32

Returns the number of items on the current page.

For all pages except potentially the last one, this will equal limit. On the last page, it may be less than limit.

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 5,
    limit: 15,
    pages: 5,
    total: 73,
    next: None,
    prev: Some(4),
};

// Last page: 73 total - (4 * 15) = 13 items on this page
assert_eq!(pagination.items_on_page(), 13);

pub fn start_index(&self) -> u32

Returns the starting item index for the current page (0-indexed).

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 2,
    limit: 15,
    pages: 5,
    total: 73,
    next: Some(3),
    prev: Some(1),
};

// Page 2, limit 15: starts at index 15
assert_eq!(pagination.start_index(), 15);

pub fn end_index(&self) -> u32

Returns the ending item index for the current page (0-indexed, exclusive).

Example

use ghost_io_api::models::pagination::Pagination;

let pagination = Pagination {
    page: 2,
    limit: 15,
    pages: 5,
    total: 73,
    next: Some(3),
    prev: Some(1),
};

// Page 2, limit 15: ends at index 30 (exclusive)
assert_eq!(pagination.end_index(), 30);

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<'de> Deserialize<'de> for Pagination

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Pagination

impl PartialEq for Pagination

fn eq(&self, other: &Pagination) -> 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 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.

impl StructuralPartialEq for Pagination