alpaca-core 0.25.1

Shared primitives for the alpaca-rust workspace
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use std::{collections::HashSet, future::Future};

use crate::Error;

pub trait PaginatedRequest: Clone {
    fn with_page_token(&self, page_token: Option<String>) -> Self;
}

pub trait PaginatedResponse: Sized {
    fn next_page_token(&self) -> Option<&str>;
    fn merge_page(&mut self, next: Self) -> Result<(), Error>;
    fn clear_next_page_token(&mut self);
}

pub async fn collect_all<Request, Response, Fetch, FutureOutput>(
    initial_request: Request,
    mut fetch_page: Fetch,
) -> Result<Response, Error>
where
    Request: PaginatedRequest,
    Response: PaginatedResponse,
    Fetch: FnMut(Request) -> FutureOutput,
    FutureOutput: Future<Output = Result<Response, Error>>,
{
    let mut combined = fetch_page(initial_request.clone()).await?;
    let mut seen_page_tokens = HashSet::new();

    while let Some(page_token) = combined.next_page_token().map(str::to_owned) {
        if !seen_page_tokens.insert(page_token.clone()) {
            return Err(Error::InvalidRequest(format!(
                "pagination contract violation: repeated next_page_token `{page_token}`"
            )));
        }

        let next_page = fetch_page(initial_request.with_page_token(Some(page_token))).await?;

        if let Some(next_page_token) = next_page.next_page_token()
            && seen_page_tokens.contains(next_page_token)
        {
            return Err(Error::InvalidRequest(format!(
                "pagination contract violation: repeated next_page_token `{next_page_token}`"
            )));
        }

        combined.merge_page(next_page)?;
    }

    combined.clear_next_page_token();
    Ok(combined)
}