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
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

//! Module: ic::model::requests::replica_versions
//!
//! Responsibility: bounded official Dashboard replica-version request contracts.
//! Does not own: transport, returned release records, validation, or rendering.
//! Boundary: captures one explicit page or one exact replica-version target.

use super::IcDashboardRequest;

use serde::Serialize;

///
/// IcReplicaVersionListQuery
///
/// One explicitly bounded official Dashboard replica-version page query.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcReplicaVersionListQuery {
    /// Maximum release rows requested from the API.
    pub limit: u16,
    /// Zero-based release-row offset.
    pub offset: u64,
    /// Optional API proposal-index ceiling returned by an earlier page.
    pub max_proposal_index: Option<u64>,
}

impl IcReplicaVersionListQuery {
    /// Construct one bounded replica-version page query.
    #[must_use]
    pub const fn new(limit: u16, offset: u64, max_proposal_index: Option<u64>) -> Self {
        Self {
            limit,
            offset,
            max_proposal_index,
        }
    }
}

///
/// IcReplicaVersionListRequest
///
/// Request accepted by the bounded official Dashboard replica-version list builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct IcReplicaVersionListRequest {
    /// Explicit Dashboard endpoint and caller collection clock.
    pub dashboard: IcDashboardRequest,
    /// Explicit page bounds.
    pub query: IcReplicaVersionListQuery,
}

impl IcReplicaVersionListRequest {
    /// Construct one bounded live Dashboard replica-version list request.
    #[must_use]
    pub const fn new(dashboard: IcDashboardRequest, query: IcReplicaVersionListQuery) -> Self {
        Self { dashboard, query }
    }
}

///
/// IcReplicaVersionInfoRequest
///
/// Request accepted by the exact official Dashboard replica-version builder.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct IcReplicaVersionInfoRequest {
    /// Explicit Dashboard endpoint and caller collection clock.
    pub dashboard: IcDashboardRequest,
    /// Exact lowercase hexadecimal replica-version identifier.
    pub replica_version_id: String,
}

impl IcReplicaVersionInfoRequest {
    /// Construct one exact live Dashboard replica-version request.
    #[must_use]
    pub fn new(dashboard: IcDashboardRequest, replica_version_id: impl Into<String>) -> Self {
        Self {
            dashboard,
            replica_version_id: replica_version_id.into(),
        }
    }
}