Struct Page 

pub struct Page<T> {
    pub items: Vec<T>,
    pub next_cursor: Option<String>,
}

One page of items plus the cursor that fetches the following page.

A next_cursor of None means the caller has reached the end.

Fields

items: Vec<T>

The rows of this page, already truncated to the requested limit.

next_cursor: Option<String>

The encoded cursor for the next page, or None at the end.

Implementations

impl<T> Page<T>

pub const fn new(items: Vec<T>, next_cursor: Option<String>) -> Self

Creates a page from already truncated items.

pub const fn empty() -> Self

Creates an empty final page.

pub fn from_rows<F>( rows: Vec<T>, params: &PageParams, normalized_filters: &F, key_of: impl FnOnce(&T) -> PageKey<String>, ) -> Result<Self, PaginationError>

where F: Serialize + ?Sized,

Truncates an over-fetched row set and issues the next cursor.

Fetch PageParams::fetch_limit rows, then hand them here. When more rows than the limit came back, the extra row is dropped and key_of is called on the last kept row to build the next cursor.

Errors

Returns PaginationError::InvalidLimit if the limit does not fit a usize, or PaginationError::InvalidCursor if the filters cannot be serialized.

pub fn map<U>(self, map: impl FnMut(T) -> U) -> Page<U>

Maps every item while keeping the cursor, for domain to DTO conversion.

Trait Implementations

impl<T: Clone> Clone for Page<T>

fn clone(&self) -> Page<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Page<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Page<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Page<T>

impl<T: PartialEq> PartialEq for Page<T>

fn eq(&self, other: &Page<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Page<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Page<T>