ic-query 0.75.13

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

//! SNS-specific bookkeeping for the shared paged refresh lifecycle.

use super::{
    SnsHostError,
    cache_attempt::{SnsRefreshContext, write_running_sns_refresh_page},
};
use crate::{
    QueryProgress,
    report::SourceFuture,
    snapshot_cache::{
        CompletePagedCollection, PagedCollectionPage, PagedCollectionState, PagedSnapshotRefresh,
        run_paged_snapshot_refresh_with_progress,
    },
};

///
/// SnsCollectionPages
///
/// Family-owned page fetching, admission, and cursor text for one SNS snapshot.
///

pub(super) trait SnsCollectionPages {
    type Row;
    type Cursor;
    const COLLECTION: &'static str;

    fn fetch_next_page<'a>(
        &'a mut self,
        context: SnsRefreshContext<'a>,
        pages: &'a mut PagedCollectionState<Self::Row, Self::Cursor>,
    ) -> SourceFuture<'a, Result<PagedCollectionPage, SnsHostError>>;

    fn cursor_text(cursor: &Self::Cursor) -> String;
}

pub(super) async fn collect_sns_snapshot<Pages: SnsCollectionPages>(
    context: SnsRefreshContext<'_>,
    fetch: Pages,
    progress: &mut dyn QueryProgress,
) -> Result<CompletePagedCollection<Pages::Row>, SnsHostError> {
    run_paged_snapshot_refresh_with_progress(
        SnsCollectionRefresh {
            context,
            fetch,
            pages: PagedCollectionState::new(),
        },
        progress,
    )
    .await
}

struct SnsCollectionRefresh<'a, Pages: SnsCollectionPages> {
    context: SnsRefreshContext<'a>,
    fetch: Pages,
    pages: PagedCollectionState<Pages::Row, Pages::Cursor>,
}

impl<Pages: SnsCollectionPages> PagedSnapshotRefresh for SnsCollectionRefresh<'_, Pages> {
    type Complete = CompletePagedCollection<Pages::Row>;
    type Error = SnsHostError;

    fn progress_text(&self) -> String {
        self.context.progress_text(
            Pages::COLLECTION,
            self.pages.page_count(),
            self.pages.row_count(),
        )
    }

    fn max_pages_reached(&self) -> bool {
        self.context.max_pages_reached(self.pages.page_count())
    }

    fn incomplete_refresh_error(&self, reason: &'static str) -> Self::Error {
        SnsRefreshContext::incomplete_refresh_error(
            self.pages.page_count(),
            self.pages.row_count(),
            reason,
        )
    }

    fn fetch_next_page(&mut self) -> SourceFuture<'_, Result<PagedCollectionPage, Self::Error>> {
        self.fetch.fetch_next_page(self.context, &mut self.pages)
    }

    fn write_running_attempt(&self) -> Result<(), Self::Error> {
        write_running_sns_refresh_page(
            self.context,
            self.pages.page_count(),
            self.pages.row_count(),
            self.pages.next_cursor().map(Pages::cursor_text),
        )
    }

    fn into_complete(self) -> Self::Complete {
        self.pages.into_complete(Pages::cursor_text)
    }
}