Struct ListResponse 

pub struct ListResponse<T: Serialize> {
    pub data: Vec<T>,
    pub total: i64,
    pub limit: u32,
    pub offset: u32,
}

A generic paginated collection response.

Serializes as:

{ "data": [...], "total": 42, "limit": 50, "offset": 0 }

Example

use axum::response::IntoResponse;
use axum_api_kit::ListResponse;
use serde::Serialize;

#[derive(Serialize)]
struct Item { id: String }

async fn list_items() -> impl IntoResponse {
    ListResponse {
        data: vec![Item { id: "1".into() }],
        total: 1,
        limit: 50,
        offset: 0,
    }
}

Fields

data: Vec<T>

The items in this page.

total: i64

Total number of matching items across all pages.

limit: u32

Maximum number of items per page (as requested).

offset: u32

Zero-based offset of the first item in this page.

Trait Implementations

impl<T: Clone + Serialize> Clone for ListResponse<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> ComposeSchema for ListResponse<T>

where T: ToSchema + Serialize,

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

impl<T: Debug + Serialize> Debug for ListResponse<T>

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

Formats the value using the given formatter.

impl<T: Serialize> IntoResponse for ListResponse<T>

fn into_response(self) -> Response

Create a response.

impl<T> Serialize for ListResponse<T>

where T: Serialize + 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 ListResponse<T>

where T: ToSchema + Serialize,

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.