Struct Page

pub struct Page { /* private fields */ }

Page struct for pagination.

This is a simple struct to handle pagination for queries.

#[derive(Table, Debug, Default, Clone, serde::Serialize, serde::Deserialize)]
pub struct Users {
    pub id: PrimaryKeyInteger,
    pub username: String,
    pub age: i32,
    pub postcode: Option<String>,
}

// Create a new Page instance
let mut page = Page::new();

// Update the page to the next page
page.next();


// Build a query to select rows from the table
let select_query = Users::query_select()
    .where_eq("username", "geekmasher")
    .page(&page)
    .order_by("age", QueryOrder::Asc)
    .build()
    .expect("Failed to build select query");

let page_max = Page::from((1, 10_000));

let option_page = Page::from((Some(5), Some(10)));

Implementations

impl Page

pub fn new() -> Self

Create a new Page instance

pub fn next(&mut self)

Update current page to the next page

pub fn prev(&mut self)

Update current page to the previous page

pub fn page(&self) -> u32

Page number

pub fn limit(&self) -> u32

Limit the rows accessed

pub fn offset(&self) -> u32

Offset for the query

pub fn pages(&self) -> u32

Total number of pages

pub fn total(&self) -> u32

Get total number of rows

pub fn set_total(&mut self, total: u32)

Set the total number of rows

pub fn max(&self) -> u32

Get the maximum number of pages based on the total number of rows

Trait Implementations

impl Debug for Page

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

Formats the value using the given formatter.

impl Default for Page

fn default() -> Self

Returns the “default value” for a type.

impl From<(Option<u32>, Option<u32>)> for Page

fn from(value: (Option<u32>, Option<u32>)) -> Self

Converts to this type from the input type.

impl From<(Option<u32>, Option<u32>, u32)> for Page

Implement From for Page (page, limit, total)

fn from(value: (Option<u32>, Option<u32>, u32)) -> Self

Converts to this type from the input type.

impl From<(u32, u32)> for Page

fn from(p: (u32, u32)) -> Self

Converts to this type from the input type.

impl From<u32> for Page

fn from(value: u32) -> Self

Converts to this type from the input type.