Struct ApiMeta 

pub struct ApiMeta {
    pub page: Option<u32>,
    pub per_page: Option<u32>,
    pub total: Option<u64>,
}

Pagination metadata.

Included in the response when the endpoint returns paginated results.

Examples

use ironflow_api::response::ApiMeta;

let meta = ApiMeta {
    page: Some(1),
    per_page: Some(20),
    total: Some(100),
};
assert_eq!(meta.page, Some(1));

Fields

page: Option<u32>

Current page number (1-based).

per_page: Option<u32>

Items per page.

total: Option<u64>

Total number of items matching the filter.

Implementations

impl ApiMeta

pub fn empty() -> Self

Create an empty metadata object (no pagination).

pub fn paginated(page: u32, per_page: u32, total: u64) -> Self

Create pagination metadata.

Trait Implementations

impl Clone for ApiMeta

fn clone(&self) -> ApiMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiMeta

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

Formats the value using the given formatter.

impl Serialize for ApiMeta

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.