pub struct NumberedPageMetadata { /* private fields */ }Expand description
Validated metadata from one numbered-page response.
Implementations§
Source§impl NumberedPageMetadata
impl NumberedPageMetadata
Sourcepub const fn new(
page: PageNumber,
page_size: u64,
previous_page: Option<PageNumber>,
next_page: Option<PageNumber>,
last_page: Option<PageNumber>,
total_entries: Option<u64>,
) -> Result<Self, PaginationError>
pub const fn new( page: PageNumber, page_size: u64, previous_page: Option<PageNumber>, next_page: Option<PageNumber>, last_page: Option<PageNumber>, total_entries: Option<u64>, ) -> Result<Self, PaginationError>
Creates coherent numbered navigation metadata.
Sourcepub const fn page(self) -> PageNumber
pub const fn page(self) -> PageNumber
Returns the current page.
Sourcepub const fn previous_page(self) -> Option<PageNumber>
pub const fn previous_page(self) -> Option<PageNumber>
Returns the previous page when advertised.
Sourcepub const fn next_page(self) -> Option<PageNumber>
pub const fn next_page(self) -> Option<PageNumber>
Returns the next page when advertised.
Sourcepub const fn last_page(self) -> Option<PageNumber>
pub const fn last_page(self) -> Option<PageNumber>
Returns the final page when known.
Sourcepub const fn total_entries(self) -> Option<u64>
pub const fn total_entries(self) -> Option<u64>
Returns the total matching entries when known.
Trait Implementations§
Source§impl Clone for NumberedPageMetadata
impl Clone for NumberedPageMetadata
Source§fn clone(&self) -> NumberedPageMetadata
fn clone(&self) -> NumberedPageMetadata
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl Copy for NumberedPageMetadata
Source§impl Debug for NumberedPageMetadata
impl Debug for NumberedPageMetadata
impl Eq for NumberedPageMetadata
Source§impl PartialEq for NumberedPageMetadata
impl PartialEq for NumberedPageMetadata
impl StructuralPartialEq for NumberedPageMetadata
Auto Trait Implementations§
impl Freeze for NumberedPageMetadata
impl RefUnwindSafe for NumberedPageMetadata
impl Send for NumberedPageMetadata
impl Sync for NumberedPageMetadata
impl Unpin for NumberedPageMetadata
impl UnsafeUnpin for NumberedPageMetadata
impl UnwindSafe for NumberedPageMetadata
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more