Struct PaginatedResponse 

pub struct PaginatedResponse<T> {
    pub records: Vec<T>,
    pub pagination: Option<QueryPaginationParams>,
    pub total: Option<i64>,
    pub total_pages: Option<i64>,
}

Represents a paginated response with records and metadata.

This is the standard response structure returned by all paginated queries. It includes the actual records, pagination information, and optionally the total count and total pages.

Type Parameters

• T - The type of records being paginated

Examples

use sqlx_paginated::PaginatedResponse;
use serde::Serialize;

#[derive(Serialize)]
struct User {
    id: i64,
    name: String,
}

// Response will be serialized as:
// {
//   "records": [...],
//   "page": 1,
//   "page_size": 10,
//   "total": 100,
//   "total_pages": 10
// }

Fields

records: Vec<T>

The records for the current page

pagination: Option<QueryPaginationParams>

Pagination metadata (page and page_size)

total: Option<i64>

Total number of records across all pages

total_pages: Option<i64>

Total number of pages

Trait Implementations

impl<T: Clone> Clone for PaginatedResponse<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for PaginatedResponse<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for PaginatedResponse<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for PaginatedResponse<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.