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, renderers, and local
5//! parsing/resolution helpers that are intended to stay free of native
6//! live-call dependencies.
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`, 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;
37pub mod cache;
38#[cfg(any(
39    feature = "dashboard-host",
40    feature = "icrc-host",
41    feature = "sns-host",
42    feature = "subnet-catalog-host"
43))]
44mod cache_file;
45#[cfg(any(
46    feature = "cloud-engine-host",
47    feature = "icrc-host",
48    feature = "nns-host",
49    feature = "sns-host"
50))]
51mod candid_call;
52#[cfg(any(
53    test,
54    all(feature = "canister", target_arch = "wasm32"),
55    feature = "cloud-engine-host",
56    feature = "cmc-host",
57    feature = "icrc-host",
58    feature = "sns-host",
59    feature = "subnet-catalog-host"
60))]
61mod candid_decode;
62#[cfg(feature = "certificate-host")]
63pub mod certificate;
64#[cfg(any(
65    feature = "certified-subnet-catalog-host",
66    feature = "cmc-host",
67    feature = "ic-state-host",
68    feature = "icrc-host"
69))]
70mod certification;
71pub mod cloud_engine;
72#[cfg(any(
73    feature = "cloud-engine-host",
74    feature = "dashboard-host",
75    feature = "icrc-host",
76    feature = "sns-host"
77))]
78mod decimal;
79#[cfg(any(
80    feature = "dashboard-host",
81    feature = "icrc-host",
82    feature = "sns-host",
83    feature = "subnet-catalog-host"
84))]
85mod freshness;
86mod hex;
87mod http_endpoint;
88mod human_quantity;
89pub mod ic;
90#[cfg(feature = "subnet-catalog-host")]
91mod ic_registry;
92pub mod icrc;
93#[cfg(any(
94    feature = "cloud-engine-host",
95    feature = "cmc-host",
96    feature = "dashboard-host",
97    feature = "sns-host",
98    feature = "subnet-catalog-host"
99))]
100mod network;
101pub mod nns;
102mod principal_text;
103#[cfg(any(
104    feature = "dashboard-host",
105    feature = "icrc-host",
106    feature = "nns-host",
107    feature = "sns-host",
108    feature = "subnet-catalog-host"
109))]
110mod progress;
111pub mod report;
112mod report_sort;
113#[cfg(any(
114    feature = "dashboard-host",
115    feature = "icrc-host",
116    feature = "nns-host",
117    feature = "sns-host"
118))]
119pub(crate) mod snapshot_cache;
120pub mod sns;
121pub mod subnet_catalog;
122pub mod system;
123
124#[cfg(any(
125    feature = "dashboard-host",
126    feature = "icrc-host",
127    feature = "sns-host",
128    feature = "subnet-catalog-host"
129))]
130pub use cache_file::{CacheFileError, HostCacheError};
131mod text_search;
132mod text_value;
133mod token_amount;
134mod token_metadata_text;
135
136#[cfg(all(
137    test,
138    any(
139        feature = "dashboard-host",
140        feature = "icrc-host",
141        feature = "sns-host",
142        feature = "subnet-catalog-host"
143    )
144))]
145mod test_support;
146
147#[cfg(test)]
148mod tests;
149
150#[cfg(any(
151    feature = "dashboard-host",
152    feature = "icrc-host",
153    feature = "nns-host",
154    feature = "sns-host",
155    feature = "subnet-catalog-host"
156))]
157pub use progress::{QueryProgress, QueryProgressEvent, QueryProgressState};
ic_query/lib.rs

ic_query/
lib.rs
