Struct ApiMeta 

pub struct ApiMeta {
    pub page: Option<u32>,
    pub per_page: Option<u32>,
    pub total: Option<u64>,
    pub extra: HashMap<String, Value>,
}

Pagination metadata returned by list endpoints.

Examples

use ironflow_types::ApiMeta;

let meta = ApiMeta::paginated(2, 50, 200);
assert_eq!(meta.page, Some(2));
assert_eq!(meta.total, Some(200));

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.

extra: HashMap<String, Value>

Additional metadata fields (e.g. cursor-based pagination).

Implementations

impl ApiMeta

pub fn empty() -> ApiMeta

Create an empty metadata object (no pagination).

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

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiMeta

fn deserialize<__D>( __deserializer: __D, ) -> Result<ApiMeta, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiMeta

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

where __S: Serializer,

Serialize this value into the given Serde serializer.