ic-query 0.87.0

Internet Computer query library for CloudEngine, NNS, SNS, ICRC, system canisters, and public network metadata
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Module: snapshot_cache::paged
//!
//! Responsibility: accumulate admitted rows across paged API walks.
//! Does not own: source fetching, progress rendering, or cache publication.
//! Boundary: tracks page counters and cursors after family-owned page validation.

///
/// CompletePagedCollection
///
/// Admitted rows and pagination metadata from a complete API walk.
///

#[cfg(any(feature = "icrc-host", feature = "sns-host"))]
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct CompletePagedCollection<Row> {
    pub rows: Vec<Row>,
    pub page_count: u32,
    pub last_cursor: Option<String>,
}

///
/// PagedCollectionPage
///
/// Per-page progress and family-admitted exhaustion evidence for the refresh runner.
///

#[cfg(any(feature = "icrc-host", feature = "nns-host", feature = "sns-host"))]
pub struct PagedCollectionPage {
    new_rows: usize,
    pub collection_exhausted: bool,
}

///
/// PagedCollectionState
///
/// Accumulates validated rows while walking a cursor-based collection.
///

#[cfg(any(feature = "icrc-host", feature = "sns-host"))]
pub struct PagedCollectionState<Row, Cursor> {
    rows: Vec<Row>,
    page_count: u32,
    next_cursor: Option<Cursor>,
}

#[cfg(any(feature = "icrc-host", feature = "sns-host"))]
impl<Row, Cursor> Default for PagedCollectionState<Row, Cursor> {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(any(feature = "icrc-host", feature = "sns-host"))]
impl<Row, Cursor> PagedCollectionState<Row, Cursor> {
    pub const fn new() -> Self {
        Self {
            rows: Vec::new(),
            page_count: 0,
            next_cursor: None,
        }
    }

    pub const fn page_count(&self) -> u32 {
        self.page_count
    }

    pub const fn row_count(&self) -> usize {
        self.rows.len()
    }

    pub const fn next_cursor(&self) -> Option<&Cursor> {
        self.next_cursor.as_ref()
    }

    /// Record rows and a cursor only after family-owned page validation.
    pub fn ingest(&mut self, rows: Vec<Row>, next_cursor: Option<Cursor>) {
        self.rows.extend(rows);
        self.page_count = self.page_count.saturating_add(1);
        self.next_cursor = next_cursor;
    }

    pub fn into_complete(
        self,
        cursor_text: impl FnOnce(&Cursor) -> String,
    ) -> CompletePagedCollection<Row> {
        CompletePagedCollection {
            rows: self.rows,
            page_count: self.page_count,
            last_cursor: self.next_cursor.as_ref().map(cursor_text),
        }
    }
}

#[cfg(any(feature = "icrc-host", feature = "nns-host", feature = "sns-host"))]
impl PagedCollectionPage {
    /// Describe one validated page and its family-owned completion decision.
    #[must_use]
    pub const fn new(new_rows: usize, collection_exhausted: bool) -> Self {
        Self {
            new_rows,
            collection_exhausted,
        }
    }

    pub const fn has_no_new_rows(&self) -> bool {
        self.new_rows == 0
    }
}