Struct Paginator 

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

Async auto-paginator returned by Client::paginate.

next_page is a plain cursor, with no dependency on futures:

use datamaxi::api::ClientBuilder;
use datamaxi::CexAnnouncementsResponse;
use std::collections::BTreeMap;

let client = ClientBuilder::new().api_key("my_api_key").build()?;
let mut pages = client
    .paginate::<CexAnnouncementsResponse>("/api/v1/cex/announcements", BTreeMap::new());

while let Some(items) = pages.next_page().await? {
    for item in items {
        println!("{}", item.title);
    }
}

With the opt-in stream feature, Paginator also implements Stream (the trait re-exported as futures::Stream by the futures crate), yielding one Result<Vec<T::Item>> per page, so it composes with futures/StreamExt combinators and .next().await:

use datamaxi::api::ClientBuilder;
use datamaxi::CexAnnouncementsResponse;
use futures::StreamExt;
use std::collections::BTreeMap;

let client = ClientBuilder::new().api_key("my_api_key").build()?;
let mut pages = client
    .paginate::<CexAnnouncementsResponse>("/api/v1/cex/announcements", BTreeMap::new());

while let Some(page) = pages.next().await {
    for item in page? {
        println!("{}", item.title);
    }
}

Implementations

impl<T> Paginator<T>

where T: Paginated + DeserializeOwned,

pub async fn next_page(&mut self) -> Result<Option<Vec<T::Item>>>

Fetches and returns the next page’s items, or Ok(None) once the server has no more data: an empty page, or (when the envelope reports a total) a page reaching page * limit >= total. Once exhausted, further calls keep returning Ok(None) rather than re-fetching.