Struct Page 

pub struct Page<T> {
    pub items: Vec<T>,
    pub total: u64,
    pub page: u64,
    pub per_page: u64,
    pub pages: u64,
    /* private fields */
}

Paginated response wrapper.

Wraps a collection of items with pagination metadata and generates RFC 5988 Link headers for navigation.

JSON Response Format

{
    "items": [...],
    "total": 100,
    "page": 2,
    "per_page": 20,
    "pages": 5
}

Link Headers

When converted to a response, includes RFC 5988 Link headers:

Link: </items?page=1&per_page=20>; rel="first",
      </items?page=1&per_page=20>; rel="prev",
      </items?page=3&per_page=20>; rel="next",
      </items?page=5&per_page=20>; rel="last"

Example

use fastapi_core::{Pagination, Page};

#[get("/users")]
async fn list_users(cx: &Cx, pagination: Pagination) -> impl IntoResponse {
    let users = fetch_users(pagination.offset(), pagination.limit()).await;
    let total = count_users().await;

    pagination.paginate(users, total, "/users")
}

Fields

items: Vec<T>

Items for the current page.

total: u64

Total number of items across all pages.

page: u64

Current page number (1-indexed).

per_page: u64

Items per page.

pages: u64

Total number of pages.

Implementations

impl<T> Page<T>

pub fn new( items: Vec<T>, total: u64, pagination: Pagination, base_url: String, ) -> Self

Create a new paginated response.

pub fn with_values( items: Vec<T>, total: u64, page: u64, per_page: u64, base_url: impl Into<String>, ) -> Self

Create a page with explicit values (for testing or manual construction).

pub fn len(&self) -> usize

Get the number of items on the current page.

pub fn is_empty(&self) -> bool

Check if the page is empty.

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 link_header(&self) -> String

Generate RFC 5988 Link header value.

Returns a string with Link headers for navigation:

• first: Link to the first page
• prev: Link to the previous page (if applicable)
• next: Link to the next page (if applicable)
• last: Link to the last page

pub fn map<U, F>(self, f: F) -> Page<U>

where F: FnMut(T) -> U,

Map the items using a transformation function.

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

fn into_response(self) -> Response

Convert into a response.