Struct PaginationOptions

pub struct PaginationOptions<T = ()>
where
    T: OrderByOptions,
{
    pub page: usize,
    pub items_per_page: usize,
    pub order_by: T,
}

Struct representing pagination options.

Examples

let options = PaginationOptions::new().page(1).items_per_page(20);

Fields

page: usize

Page number.

• If the value is 0, it will default to 1.
• If the value exceeds the maximum page number, it will be considered as the maximum page number.

Default: 1.

items_per_page: usize

Number of items per page.

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

Default: 0.

order_by: T

Ordering options which has to implement the OrderByOptions trait.

Default: ().

Implementations

impl PaginationOptions

pub const fn new() -> PaginationOptions

Create a new PaginationOptions.

let options = PaginationOptions::new();
// equals to
let options = PaginationOptions {
    page:           1,
    items_per_page: 0,
    order_by:       (),
};

impl<T> PaginationOptions<T>

where T: OrderByOptions,

pub const fn page(self, page: usize) -> PaginationOptions<T>

Set the page number.

• If the value is 0, it will be considered as 1.
• If the value exceeds the maximum page number, it will be considered as the maximum page number.

pub const fn items_per_page(self, items_per_page: usize) -> PaginationOptions<T>

Set the number of items per page.

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

pub fn order_by(self, order_by: T) -> PaginationOptions<T>

Set the ordering options which has to implement the OrderByOptions trait.

pub const fn offset(&self) -> u64

Compute the offset for pagination.

pub const fn limit(&self) -> Option<usize>

Compute the limit for pagination. None means unlimited.

impl<T> PaginationOptions<T>

where T: OrderByOptions,

pub fn to_mysql_limit_offset<'a>(&self, s: &'a mut String) -> &'a str

Generate a LIMIT with OFFSET clause for MySQL.

If limit() is Some(n),

LIMIT <limit()> [OFFSET <offset()>]

If offset() is not zero,

[LIMIT <limit()>] OFFSET <offset()>

impl<T> PaginationOptions<T>

where T: OrderByOptions,

pub fn to_sqlite_limit_offset<'a>(&self, s: &'a mut String) -> &'a str

Generate a LIMIT with OFFSET clause for SQLite.

If limit() is Some(n),

LIMIT <limit()> [OFFSET <offset()>]

If offset() is not zero,

[LIMIT <limit()>] OFFSET <offset()>

Trait Implementations

impl<T> Clone for PaginationOptions<T>

where T: Clone + OrderByOptions,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PaginationOptions<T>

where T: Debug + OrderByOptions,

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

Formats the value using the given formatter.

impl<T> Default for PaginationOptions<T>

where T: OrderByOptions,

fn default() -> PaginationOptions<T>

Create a new PaginationOptions<T>.

let options = <PaginationOptions<()>>::default();
// equals to
let options = PaginationOptions {
    page:           1,
    items_per_page: 0,
    order_by:       (),
};

impl<'de, T> Deserialize<'de> for PaginationOptions<T>

where T: OrderByOptions + Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<PaginationOptions<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for PaginationOptions<T>

where T: OrderByOptions + 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.