Struct paginator::PaginatorBuilder

pub struct PaginatorBuilder {
    pub total_pages: usize,
    pub current_page: usize,
    pub max_item_count: usize,
    pub start_size: usize,
    pub end_size: usize,
    pub has_prev: YesNoDepends,
    pub has_next: YesNoDepends,
}

A struct to create Paginator or PaginatorIter.

Fields

total_pages: usize

The number of pages.

current_page: usize

The number of the current page.

max_item_count: usize

The max number of PageItems after generated.

start_size: usize

The number of PageItems (the PageItem::Prev item is excluded) on the start edge (before the first PageItem::Ignore item).

end_size: usize

The number of PageItems (the PageItem::Next item is excluded) on the end edge (after the last PageItem::Ignore item).

has_prev: YesNoDepends

Whether to add the PageItem::Prev item.

has_next: YesNoDepends

Whether to add the PageItem::Next item.

Implementations

impl PaginatorBuilder

pub const fn new(total_pages: usize) -> PaginatorBuilder

Create a new PaginatorBuilder with some default options.

PaginatorBuilder {
    total_pages, // this is input by the caller.
    current_page: 1,
    max_item_count: 9,
    start_size: 1,
    end_size: 1,
    has_prev: YesNoDepends::Depends,
    has_next: YesNoDepends::Depends,
}

pub const fn total_pages(self, total_pages: usize) -> PaginatorBuilder

Set the number of pages.

pub const fn current_page(self, current_page: usize) -> PaginatorBuilder

Set the number of the current page.

pub const fn max_item_count(self, max_item_count: usize) -> PaginatorBuilder

Set the max number of PageItems after generated.

pub const fn start_size(self, start_size: usize) -> PaginatorBuilder

Set the number of PageItems (the PageItem::Prev item is excluded) on the start edge (before the first PageItem::Ignore item).

pub const fn end_size(self, end_size: usize) -> PaginatorBuilder

Set the number of PageItems (the PageItem::Next item is excluded) on the end edge (after the last PageItem::Ignore item).

pub const fn has_prev(self, has_prev: YesNoDepends) -> PaginatorBuilder

Set whether to add the PageItem::Prev item.

pub const fn has_next(self, has_next: YesNoDepends) -> PaginatorBuilder

Set whether to add the PageItem::Next item.

impl PaginatorBuilder

pub fn build_paginator(self) -> Result<Paginator, PaginatorBuildError>

pub fn build_paginator_iter(self) -> Result<PaginatorIter, PaginatorBuildError>

Trait Implementations

impl Clone for PaginatorBuilder

fn clone(&self) -> PaginatorBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaginatorBuilder

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

Formats the value using the given formatter.

impl PartialEq<PaginatorBuilder> for PaginatorBuilder

fn eq(&self, other: &PaginatorBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PaginatorBuilder

impl StructuralEq for PaginatorBuilder

impl StructuralPartialEq for PaginatorBuilder