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 and runtime helper. 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 = "certified-subnet-catalog-host",
47    feature = "cmc-host",
48    feature = "ic-state-host",
49    feature = "icrc-host"
50))]
51mod certification;
52pub mod cloud_engine;
53pub mod duration;
54#[cfg(any(
55    feature = "dashboard-host",
56    feature = "icrc-host",
57    feature = "sns-host",
58    feature = "subnet-catalog-host"
59))]
60mod freshness;
61mod hex;
62#[cfg(any(
63    feature = "cloud-engine-host",
64    feature = "cmc-host",
65    feature = "dashboard-host",
66    feature = "ic-state-host",
67    feature = "icrc-host",
68    feature = "sns-host",
69    feature = "subnet-catalog-host"
70))]
71mod http_endpoint;
72mod human_quantity;
73pub mod ic;
74#[cfg(feature = "subnet-catalog-host")]
75mod ic_registry;
76pub mod icrc;
77#[cfg(any(feature = "certified-subnet-catalog-host", feature = "ic-state-host"))]
78mod leb128;
79#[cfg(any(
80    feature = "cloud-engine-host",
81    feature = "cmc-host",
82    feature = "dashboard-host",
83    feature = "sns-host",
84    feature = "subnet-catalog-host"
85))]
86mod network;
87pub mod nns;
88#[cfg(any(
89    feature = "dashboard-host",
90    feature = "icrc-host",
91    feature = "nns-host",
92    feature = "sns-host"
93))]
94mod progress;
95pub mod report;
96mod report_sort;
97#[cfg(any(
98    feature = "cloud-engine-host",
99    feature = "cmc-host",
100    feature = "dashboard-host",
101    feature = "ic-state-host",
102    feature = "icrc-host",
103    feature = "sns-host",
104    feature = "subnet-catalog-host"
105))]
106mod runtime;
107#[cfg(any(
108    feature = "dashboard-host",
109    feature = "icrc-host",
110    feature = "nns-host",
111    feature = "sns-host"
112))]
113pub(crate) mod snapshot_cache;
114pub mod sns;
115pub mod subnet_catalog;
116pub mod system;
117
118#[cfg(any(
119    feature = "dashboard-host",
120    feature = "icrc-host",
121    feature = "sns-host",
122    feature = "subnet-catalog-host"
123))]
124pub use cache_file::{CacheFileError, HostCacheError};
125mod table;
126mod text_search;
127mod text_value;
128mod token_amount;
129mod token_metadata_text;
130
131#[cfg(all(
132    test,
133    any(
134        feature = "dashboard-host",
135        feature = "icrc-host",
136        feature = "sns-host",
137        feature = "subnet-catalog-host"
138    )
139))]
140mod test_support;
141
142#[cfg(test)]
143mod tests;
144
145#[cfg(any(
146    feature = "dashboard-host",
147    feature = "icrc-host",
148    feature = "nns-host",
149    feature = "sns-host"
150))]
151pub use progress::{QueryProgress, QueryProgressEvent, QueryProgressState};
ic_query/lib.rs

ic_query/
lib.rs
