datafusion_delta_sharing/client/
pagination.rs

1//! Pagination support for the client.
2
3use reqwest::Url;
4
5const QUERY_PARAM_MAX_RESULTS: &str = "maxResults";
6const QUERY_PARAM_PAGE_TOKEN: &str = "pageToken";
7
8/// Pagination information for the request.
9#[derive(Debug)]
10pub struct Pagination {
11    max_results: Option<u32>,
12    page_token: Option<String>,
13    is_start: bool,
14}
15
16impl Pagination {
17    /// Create a new Pagination
18    pub fn new(max_results: Option<u32>, page_token: Option<String>, is_start: bool) -> Self {
19        Self {
20            max_results,
21            page_token,
22            is_start,
23        }
24    }
25
26    /// Create a new Pagination for the first page
27    pub fn start(max_results: Option<u32>, page_token: Option<String>) -> Self {
28        Self::new(max_results, page_token, true)
29    }
30
31    /// Set the next page token
32    pub fn set_next_token(&mut self, token: Option<String>) {
33        self.is_start = false;
34        self.page_token = token;
35    }
36
37    /// Check if there is another page of results
38    pub fn has_next_page(&self) -> bool {
39        self.is_start || (self.page_token.is_some() && self.page_token.as_deref() != Some(""))
40    }
41
42    /// Check if the pagination is finished
43    pub fn is_finished(&self) -> bool {
44        !self.has_next_page()
45    }
46}
47
48impl Default for Pagination {
49    fn default() -> Self {
50        Self::new(None, None, true)
51    }
52}
53
54pub(crate) trait PaginationExt {
55    fn set_pagination(&mut self, pagination: &Pagination);
56}
57
58impl PaginationExt for Url {
59    fn set_pagination(&mut self, pagination: &Pagination) {
60        if pagination.max_results.is_none() && pagination.page_token.is_none() {
61            return;
62        }
63
64        let mut query_pairs = self.query_pairs_mut();
65        if let Some(m) = pagination.max_results {
66            query_pairs.append_pair(QUERY_PARAM_MAX_RESULTS, &m.to_string());
67        };
68        if let Some(token) = &pagination.page_token {
69            query_pairs.append_pair(QUERY_PARAM_PAGE_TOKEN, token);
70        };
71        drop(query_pairs);
72    }
73}
datafusion_delta_sharing/client/pagination.rs

datafusion_delta_sharing/client/
pagination.rs
