Struct PageMetadata 

pub struct PageMetadata { /* private fields */ }

Validated metadata from one paginated provider response.

Implementations

impl PageMetadata

pub const fn new( page: PageNumber, per_page: u64, previous_page: Option<PageNumber>, next_page: Option<PageNumber>, last_page: Option<PageNumber>, total_entries: Option<u64>, ) -> Result<Self, PaginationError>

Creates coherent page navigation metadata.

pub const fn page(self) -> PageNumber

Returns the current page.

pub const fn per_page(self) -> u64

Returns the requested maximum entries per page.

pub const fn previous_page(self) -> Option<PageNumber>

Returns the previous page when advertised.

pub const fn next_page(self) -> Option<PageNumber>

Returns the next page when advertised.

pub const fn last_page(self) -> Option<PageNumber>

Returns the final page when known.

pub const fn total_entries(self) -> Option<u64>

Returns the total matching entries when known.

Trait Implementations

impl Clone for PageMetadata

fn clone(&self) -> PageMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PageMetadata

impl Debug for PageMetadata

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

Formats the value using the given formatter.

impl Eq for PageMetadata

impl PartialEq for PageMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageMetadata