Struct Page 

pub struct Page<T: JsonSchema> {
    pub items: Vec<T>,
    pub page: u32,
    pub per_page: u32,
    pub total: u64,
    pub total_pages: u64,
    pub has_next: bool,
    pub has_prev: bool,
}

A page of results plus the metadata a client needs to walk the rest.

Fields

items: Vec<T>

The items on this page.

page: u32

1-based page number these items came from.

per_page: u32

Page size used for this query.

total: u64

Total number of items across all pages.

total_pages: u64

Total number of pages given total and per_page (at least 1).

has_next: bool

Whether a next page exists.

has_prev: bool

Whether a previous page exists.

Implementations

impl<T: JsonSchema> Page<T>

pub fn new(items: Vec<T>, params: PageParams, total: u64) -> Self

Build a response envelope from a fetched slice, the request’s PageParams, and the total row count.

Trait Implementations

impl<T: Clone + JsonSchema> 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 + JsonSchema> Debug for Page<T>

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

Formats the value using the given formatter.

impl<T: JsonSchema + JsonSchema> JsonSchema for Page<T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T> Serialize for Page<T>

where T: Serialize + JsonSchema,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.