Struct Pagination

pub struct Pagination { /* private fields */ }

Implementations

impl Pagination

pub fn new(page: u32, limit: u32, max_limit: Option<u32>) -> Self

Create new pagination

max_limit is optional and will be clamped between PAGINATION_MIN_LIMIT and PAGINATION_MAX_LIMIT

Examples

use api_tools::value_objects::pagination::{Pagination, PAGINATION_MAX_LIMIT, PAGINATION_MIN_LIMIT};

let pagination = Pagination::new(1, 100, None);
assert_eq!(pagination.page(), 1);
assert_eq!(pagination.limit(), 100);

// Invalid page
let pagination = Pagination::new(0, 100, None);
assert_eq!(pagination.page(), 1);
assert_eq!(pagination.limit(), 100);

// Limit too small
let pagination = Pagination::new(2, 10, None);
assert_eq!(pagination.page(), 2);
assert_eq!(pagination.limit(), PAGINATION_MIN_LIMIT);

// Limit too big
let pagination = Pagination::new(2, 1_000, None);
assert_eq!(pagination.page(), 2);
assert_eq!(pagination.limit(), PAGINATION_MAX_LIMIT);

// Limit too big and max limit greater than max
let pagination = Pagination::new(2, 1_000, Some(800));
assert_eq!(pagination.page(), 2);
assert_eq!(pagination.limit(), PAGINATION_MAX_LIMIT);

pub fn page(&self) -> u32

Get page

pub fn limit(&self) -> u32

Get limit

pub fn set_max_limit(&mut self, max_limit: u32)

Set a max limit (between PAGINATION_MIN_LIMIT and PAGINATION_MAX_LIMIT)

Trait Implementations

impl Clone for Pagination

fn clone(&self) -> Pagination

Returns a copy 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 Default for Pagination

fn default() -> Self

Default 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 Eq for Pagination

impl StructuralPartialEq for Pagination