Struct PaginatedResponse 

pub struct PaginatedResponse<T> {
    pub items: Vec<T>,
    pub total_count: u64,
    pub has_more: bool,
    pub limit: u64,
    pub offset: u64,
}

Offset-based paginated response envelope with a flat shape.

Requires std or alloc.

All list endpoints that use PaginationParams should wrap their result with this type so SDK consumers always see the same contract.

{
  "items": [...],
  "total_count": 42,
  "has_more": true,
  "limit": 20,
  "offset": 0
}

Fields

items: Vec<T>

The items on this page.

total_count: u64

Total number of items across all pages.

has_more: bool

Whether more items exist beyond this page.

limit: u64

Maximum number of items returned per page.

offset: u64

Number of items skipped before this page.

Implementations

impl<T> PaginatedResponse<T>

pub fn new(items: Vec<T>, total_count: u64, params: &PaginationParams) -> Self

Build a paginated response from items, total count, and the query params.

has_more is set to true when offset + items.len() < total_count.

Examples

use api_bones::pagination::{PaginatedResponse, PaginationParams};

let params = PaginationParams::default();
let resp = PaginatedResponse::new(vec![1, 2, 3], 25, &params);
assert!(resp.has_more);
assert_eq!(resp.total_count, 25);
assert_eq!(resp.limit, 20);
assert_eq!(resp.offset, 0);

let resp = PaginatedResponse::new(vec![1, 2, 3], 3, &params);
assert!(!resp.has_more);

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: PartialEq> PartialEq for PaginatedResponse<T>

fn eq(&self, other: &PaginatedResponse<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl<T> StructuralPartialEq for PaginatedResponse<T>