Struct PageDto 

pub struct PageDto<T> {
    pub page: Option<u32>,
    pub page_size: Option<u32>,
    pub total_pages: Option<u32>,
    pub total_items: u32,
    pub items: Vec<T>,
}

A page of items, as returned by a paginated query.

Fields

page: Option<u32>

The page returned (0 based), as requested.

page_size: Option<u32>

The number of items per page, as requested.

total_pages: Option<u32>

The number of pages (none without a page size).

total_items: u32

The number of items over every page.

items: Vec<T>

The items of the page.

Implementations

impl<T> PageDto<T>

pub fn new( page: Option<u32>, page_size: Option<u32>, total_items: u32, items: Vec<T>, ) -> Self

A page of items, out of total_items, computing the number of pages.

Trait Implementations

impl<T: Clone> Clone for PageDto<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> ComposeSchema for PageDto<T>

where T: ToSchema,

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl<T: Debug> Debug for PageDto<T>

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

Formats the value using the given formatter.

impl<T> JsonSchema for PageDto<T>

where T: JsonSchema,

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<T> Serialize for PageDto<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> ToSchema for PageDto<T>

where T: ToSchema,

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.