ic-query 0.59.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

//! Module: sns::report::model::requests::refresh
//!
//! Responsibility: define common complete SNS snapshot refresh settings.
//! Does not own: collection choice, cursor rules, source calls, or publication.
//! Boundary: neuron and proposal entry points select the collection explicitly.

use super::lookup::SnsLookupRequest;
use std::path::PathBuf;

///
/// SnsSnapshotRefreshRequest
///
/// Request accepted by the complete SNS snapshot refresh builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct SnsSnapshotRefreshRequest {
    /// SNS target, explicit endpoint, network and caller clock.
    pub lookup: SnsLookupRequest,
    /// Caller-selected root for confined managed cache files.
    pub cache_root: PathBuf,
    /// Maximum rows requested per Governance page.
    pub page_size: u32,
    /// Optional page ceiling; reaching it before exhaustion prevents complete publication.
    pub max_pages: Option<u32>,
}

impl SnsSnapshotRefreshRequest {
    /// Construct snapshot refresh settings using the caller clock.
    #[must_use]
    pub fn new(cache_root: impl Into<PathBuf>, lookup: SnsLookupRequest, page_size: u32) -> Self {
        Self {
            lookup,
            cache_root: cache_root.into(),
            page_size,
            max_pages: None,
        }
    }

    /// Bound refresh pagination; truncated collections are not published as complete.
    #[must_use]
    pub const fn with_max_pages(mut self, max_pages: Option<u32>) -> Self {
        self.max_pages = max_pages;
        self
    }
}