ic-query 0.30.15

Internet Computer query library for 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
85
86
87
88
89
90

//! Module: cache_file
//!
//! Responsibility: shared cache-file IO, locking, and refresh policy.
//! Does not own: command-specific cache schemas, report DTOs, or live refreshes.
//! Boundary: exposes reusable cache mechanics used by NNS and SNS report modules.

mod confined;
mod error;
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host",
    feature = "sns-host"
))]
mod json;
mod lock;
mod policy;
#[cfg(all(test, feature = "host"))]
mod tests;
mod write;

#[cfg(feature = "sns-host")]
pub use confined::collect_managed_collection_files;
#[cfg(any(feature = "icrc-host", feature = "nns-host", feature = "sns-host"))]
pub use confined::read_managed_file;
#[cfg(feature = "host")]
pub use confined::{collect_managed_files, open_managed_file};
pub use confined::{
    create_managed_parent_directory, managed_file_exists, read_managed_text,
    write_managed_text_atomically,
};
pub use error::{CacheFileError, HostCacheError};
#[cfg(any(feature = "icrc-host", feature = "nns-topology-host"))]
pub use json::HostJsonCacheErrorMapper;
#[cfg(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))]
pub use json::OwnerJsonCacheErrorMapper;
#[cfg(feature = "nns-topology-host")]
pub use json::load_json_cache;
#[cfg(all(
    feature = "icrc-host",
    not(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))
))]
pub use json::load_json_cache_strict;
#[cfg(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))]
pub use json::{CachedJsonReport, LoadJsonCacheErrorMapper, load_json_cache_strict};
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host",
    feature = "sns-host"
))]
pub use json::{JsonCacheReport, LoadJsonCacheRequest};
pub use lock::RefreshLockRequest;
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host",
    feature = "sns-host"
))]
pub use lock::with_refresh_lock;
#[cfg(feature = "subnet-catalog-host")]
pub use lock::with_refresh_lock_async;
#[cfg(feature = "host")]
pub use lock::{RefreshLockEvidence, inspect_refresh_lock};
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host",
    feature = "sns-host"
))]
pub use policy::CacheRefreshReason;
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host"
))]
pub use policy::load_or_refresh_cache_with_error_policy;
#[cfg(feature = "sns-host")]
pub use policy::load_or_refresh_missing_cache;
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "nns-topology-host",
    feature = "sns-host"
))]
pub use policy::{host_cache_refresh_reason, load_or_refresh_stale_cache_with_error_policy};
#[cfg(any(feature = "nns-host", feature = "subnet-catalog-host"))]
pub use write::write_text_output;
#[cfg(feature = "nns-host")]
pub use write::{RefreshCacheWriteRequest, RefreshCacheWriteResult, write_json_refresh_cache};