Struct Pagination

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

Pagination parameters

Fields

before: Option<Ulid>

The cursor to start from

after: Option<Ulid>

The cursor to end at

count: usize

The maximum number of items to return

direction: PaginationDirection

In which direction to paginate

Implementations

impl Pagination

pub const fn try_new( before: Option<Ulid>, after: Option<Ulid>, 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 const fn before(self, id: Ulid) -> Self

Get items before the given cursor

pub const fn clear_before(self) -> Self

Clear the before cursor

pub const fn after(self, id: Ulid) -> Self

Get items after the given cursor

pub const fn clear_after(self) -> Self

Clear the after cursor

pub fn process<T>(&self, edges: Vec<T>) -> Page<T>

Process a page returned by a paginated query

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 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 Copy for Pagination

impl Eq for Pagination

impl StructuralPartialEq for Pagination