Struct Paginated 

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

Paginated response wrapper with metadata and navigation links.

Automatically generates:

• JSON body with items, meta (page, per_page, total, total_pages), and _links
• RFC 8288 Link response headers for first/prev/next/last

Example

use rustapi_core::{Paginate, Json};
use rustapi_core::hateoas::Paginated;

async fn list_users(paginate: Paginate) -> Paginated<User> {
    let users = db.query_users(paginate.offset(), paginate.limit()).await;
    let total = db.count_users().await;
    paginate.paginate(users, total)
}

Fields

items: Vec<T>

The items for this page

page: u64

Current page number (1-indexed)

per_page: u64

Items per page

total: u64

Total number of items across all pages

Implementations

impl<T> Paginated<T>

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

Create a new paginated response

pub fn total_pages(&self) -> u64

Calculate total number of pages

pub fn has_next(&self) -> bool

Check if there is a next page

pub fn has_prev(&self) -> bool

Check if there is a previous page

pub fn map<U, F: FnMut(T) -> U>(self, f: F) -> Paginated<U>

Map items to a different type

Trait Implementations

impl<T: Clone> Clone for Paginated<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Paginated<T>

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

Formats the value using the given formatter.

impl<T: Serialize + Send> IntoResponse for Paginated<T>

fn into_response(self) -> Response

Convert self into a Response