Struct Pagination

pub struct Pagination<Cursor = Ulid> {
    pub before: Option<Cursor>,
    pub after: Option<Cursor>,
    pub count: usize,
    pub direction: PaginationDirection,
}

Pagination parameters

Fields

before: Option<Cursor>

The cursor to start from

after: Option<Cursor>

The cursor to end at

count: usize

The maximum number of items to return

direction: PaginationDirection

In which direction to paginate

Implementations

impl<C> Pagination<C>

pub fn try_new( before: Option<C>, after: Option<C>, first: Option<usize>, last: Option<usize>, ) -> Result<Self, InvalidPagination>

Creates a new Pagination from user-provided parameters.

Errors

Either first or last must be provided, else this function will return an InvalidPagination error.

pub const fn first(first: usize) -> Self

Creates a Pagination which gets the first N items

pub const fn last(last: usize) -> Self

Creates a Pagination which gets the last N items

pub fn before(self, cursor: C) -> Self

Get items before the given cursor

pub fn clear_before(self) -> Self

Clear the before cursor

pub fn after(self, cursor: C) -> Self

Get items after the given cursor

pub fn clear_after(self) -> Self

Clear the after cursor

pub fn process<T: Node<C>>(&self, nodes: Vec<T>) -> Page<T, C>

Process a page returned by a paginated query

Trait Implementations

impl<Cursor: Clone> Clone for Pagination<Cursor>

fn clone(&self) -> Pagination<Cursor>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Cursor: Debug> Debug for Pagination<Cursor>

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

Formats the value using the given formatter.

impl<Cursor: PartialEq> PartialEq for Pagination<Cursor>

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

impl<Cursor: Eq> Eq for Pagination<Cursor>

impl<Cursor> StructuralPartialEq for Pagination<Cursor>