ic_query/
lib.rs

1//! Reusable report models and helpers for Internet Computer metadata queries.
2//!
3//! The default feature set is empty. A dependency using
4//! `default-features = false` gets the pure report DTOs, JSON contracts, and local
5//! parsing/resolution helpers that are intended to stay free of native
6//! live-call dependencies. Human-facing rendering lives in `ic-query-text`.
7//!
8//! This is a host dependency boundary, not a `no_std` promise. No-default
9//! builds are expected to compile for `wasm32-unknown-unknown` without
10//! `ic-agent`, Reqwest, Tokio, or `futures-util`, but they may still use ordinary
11//! `std` types such as `String` and `Vec`.
12//!
13//! Enable `dashboard-host` for official Dashboard live/cache APIs,
14//! `ic-state-host` for certified IC state-tree reports,
15//! `cloud-engine-host` for native CloudEngine control-plane reports (combine it
16//! with `subnet-catalog-host` for the Registry-backed CloudEngine list),
17//! `icrc-host` for native ICRC ledger/index APIs, `sns-host` for native SNS
18//! live/cache APIs, `cmc-host` for certified Cycles Minting Canister reports,
19//! `subnet-catalog-host` for the focused live/cache Subnet catalog API,
20//! `certified-subnet-catalog-host` for that API plus certified Registry archive,
21//! replay, and archive-bound catalog authority,
22//! `nns-topology-host` for that API plus exact-version joined NNS Subnet
23//! topology, `nns-host` for the complete NNS host surface, `canister` for the
24//! replicated NNS Governance adapter on `wasm32`, or `host` for every native
25//! live-call adapter. CLI parsing and process IO belong to
26//! the separate `ic-query-cli` crate.
27
28#[cfg(any(
29    feature = "cloud-engine-host",
30    feature = "cmc-host",
31    feature = "ic-state-host",
32    feature = "icrc-host",
33    feature = "sns-host",
34    feature = "subnet-catalog-host"
35))]
36mod agent;
37#[cfg(any(
38    feature = "cloud-engine-host",
39    feature = "cmc-host",
40    feature = "icrc-host",
41    feature = "sns-host",
42    feature = "subnet-catalog-host"
43))]
44mod agent_transport;
45pub mod cache;
46#[cfg(any(
47    feature = "dashboard-host",
48    feature = "icrc-host",
49    feature = "sns-host",
50    feature = "subnet-catalog-host"
51))]
52mod cache_file;
53#[cfg(any(
54    feature = "cloud-engine-host",
55    feature = "cmc-host",
56    feature = "icrc-host",
57    feature = "nns-host",
58    feature = "sns-host"
59))]
60mod candid_call;
61#[cfg(any(
62    test,
63    all(feature = "canister", target_arch = "wasm32"),
64    feature = "cloud-engine-host",
65    feature = "cmc-host",
66    feature = "icrc-host",
67    feature = "sns-host",
68    feature = "subnet-catalog-host"
69))]
70mod candid_decode;
71#[cfg(feature = "certificate-host")]
72pub mod certificate;
73#[cfg(any(
74    feature = "certified-subnet-catalog-host",
75    feature = "cmc-host",
76    feature = "ic-state-host",
77    feature = "icrc-host"
78))]
79mod certification;
80pub mod cloud_engine;
81#[cfg(any(
82    feature = "cloud-engine-host",
83    feature = "dashboard-host",
84    feature = "icrc-host",
85    feature = "sns-host"
86))]
87mod decimal;
88#[cfg(any(
89    feature = "dashboard-host",
90    feature = "icrc-host",
91    feature = "sns-host",
92    feature = "subnet-catalog-host"
93))]
94mod freshness;
95mod hex;
96mod http_endpoint;
97pub mod ic;
98#[cfg(feature = "subnet-catalog-host")]
99mod ic_registry;
100pub mod icrc;
101mod identifier_match;
102#[cfg(any(
103    feature = "cloud-engine-host",
104    feature = "cmc-host",
105    feature = "dashboard-host",
106    feature = "sns-host",
107    feature = "subnet-catalog-host"
108))]
109mod network;
110pub mod nns;
111mod principal_text;
112#[cfg(any(
113    feature = "dashboard-host",
114    feature = "icrc-host",
115    feature = "nns-host",
116    feature = "sns-host",
117    feature = "subnet-catalog-host"
118))]
119mod progress;
120pub mod report;
121mod report_sort;
122#[cfg(any(
123    feature = "dashboard-host",
124    feature = "icrc-host",
125    feature = "nns-host",
126    feature = "sns-host"
127))]
128pub(crate) mod snapshot_cache;
129pub mod sns;
130pub mod subnet_catalog;
131pub mod system;
132
133#[cfg(any(
134    feature = "dashboard-host",
135    feature = "icrc-host",
136    feature = "sns-host",
137    feature = "subnet-catalog-host"
138))]
139pub use cache_file::{CacheFileError, HostCacheError};
140mod text_search;
141
142#[cfg(all(
143    test,
144    any(
145        feature = "dashboard-host",
146        feature = "icrc-host",
147        feature = "sns-host",
148        feature = "subnet-catalog-host"
149    )
150))]
151mod test_support;
152
153#[cfg(any(
154    feature = "dashboard-host",
155    feature = "icrc-host",
156    feature = "nns-host",
157    feature = "sns-host",
158    feature = "subnet-catalog-host"
159))]
160pub use progress::{
161    PagedQueryProgress, QueryProgress, QueryProgressCollection, QueryProgressEvent,
162    QueryProgressState,
163};
ic_query/lib.rs

ic_query/
lib.rs
