Struct Paginator 

pub struct Paginator<T> { /* private fields */ }

iterator for paginated api results

this allows iterating through all pages of results automatically.

Example

use netbox::{Client, ClientConfig};

// let mut paginator = client.dcim().devices().paginate(None)?;
//
// while let Some(page) = paginator.next_page().await? {
//     for device in page.results {
//         println!("{:?}", device);
//     }
// }

Implementations

impl<T> Paginator<T>

where T: DeserializeOwned,

pub async fn next_page(&mut self) -> Result<Option<Page<T>>>

fetch the next page of results

returns Ok(None) when there are no more pages.

pub async fn collect_all(self) -> Result<Vec<T>>

collect all results from all pages into a single vector

Warning: This will fetch all pages, which could be slow and memory-intensive for large result sets.

pub fn limit_pages(self, max_pages: usize) -> LimitedPaginator<T>

limit the number of pages to fetch