Struct Page 

pub struct Page<T> {
    pub items: Vec<T>,
    pub total: u64,
    pub page: u64,
    pub per_page: u64,
    pub total_pages: u64,
}

One page of T as a response body.

Its schema is inlined rather than named, so pages of different item types never collide in components.schemas.

Fields

items: Vec<T>

The items of this page.

total: u64

Items over all pages, counted before the page was fetched.

page: u64

1-based number of this page.

per_page: u64

Requested page size.

total_pages: u64

Number of pages for total items.

Implementations

impl<T> Page<T>

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

The same page with each item converted by f.

pub fn try_map<U, E, F>(self, f: F) -> Result<Page<U>, E>

where F: FnMut(T) -> Result<U, E>,

The same page with each item converted by f, stopping at the first error.

Errors

The first error f returns.

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<T: Dump> Dump for Page<T>

fn serialize_dump<S: Serializer>( &self, serializer: S, opts: &DumpOptions, ) -> Result<S::Ok, S::Error>

Serialize directly when supported, preserving dump semantics.

fn dump(&self, opts: &DumpOptions) -> Result<Value, DumpError>

Serialize with opts applied.

impl<M> From<Page<M>> for Page<M>

fn from(page: Page<M>) -> Self

Converts to this type from the input type.

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: Schema + 'static> Schema for Page<T>

fn schema(registry: &mut SchemaRegistry) -> SchemaObject

The schema definition of this type. Use SchemaRegistry::subschema for nested types.

fn schema_name() -> Option<&'static str>

Stable component name. Named types are emitted once under components.schemas and referenced with $ref.

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>