Struct Page 

pub struct Page<M> {
    pub items: Vec<M>,
    pub total: Option<u64>,
    pub next: Option<Cursor>,
    pub totals: Vec<Total>,
    pub groups: Vec<Group>,
}

One page of a list.

use zeyn::Page;
let page = Page::new(vec![1, 2, 3]).total(120);
assert_eq!(page.total, Some(120));

Fields

items: Vec<M>

total: Option<u64>

Total row count. Optional because counting can be expensive on large tables.

next: Option<Cursor>

Where the next batch starts. None means there is nothing more.

totals: Vec<Total>

Column totals over the whole filtered result, not only this page. Filled for the aggregates the query asked for (DataQuery::aggregates).

groups: Vec<Group>

Groups of rows, filled instead of items when the query asks for them (DataQuery::group). total and next then count groups.

Implementations

impl<M> Page<M>

pub fn new(items: Vec<M>) -> Self

pub fn with_total( self, field: impl Into<String>, op: Aggregate, value: Value, ) -> Self

Adds a column total. Data layers that page in SQL compute totals with one aggregate query.

pub fn total(self, total: u64) -> Self

pub fn next(self, cursor: Cursor) -> Self

impl<M: Clone> Page<M>

pub fn from_slice(all: &[M], query: &DataQuery) -> Self

Pages an in memory list. Meant for small data, samples and tests; databases page in SQL.

The cursor here is a row position, which is only stable because the list does not change.

Trait Implementations

impl<M: Model> ApiOutput for Page<M>

fn schema() -> Json

fn protect(value: &mut Json, ctx: &Ctx)

Masks masked fields of the serialized output for users who may not reveal them, and records reveals and sensitive reads for the audit log.

impl<M: Clone> Clone for Page<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Page<M>

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

Formats the value using the given formatter.

impl<M> Default for Page<M>

fn default() -> Self

Returns the “default value” for a type.

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

where M: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<M: PartialEq> PartialEq for Page<M>

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

Equality operator ==.

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

Inequality operator !=.

impl<M> Serialize for Page<M>

where M: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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