ic-query 0.45.11

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

//! Module: cache_file::write
//!
//! Responsibility: shared atomic and refresh-cache write helpers.
//! Does not own: JSON cache schemas, refresh locking internals, or report construction.
//! Boundary: exposes parent creation, atomic text writes, and refresh publication helpers.

use crate::cache_file::CacheFileError;
use std::path::Path;

#[cfg(any(
    feature = "certified-subnet-catalog-host",
    feature = "subnet-catalog-host",
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "sns-host"
))]
mod json;
#[cfg(feature = "subnet-catalog-host")]
mod output;
#[cfg(feature = "subnet-catalog-host")]
mod path;
#[cfg(feature = "nns-host")]
mod refresh;
#[cfg(all(test, feature = "subnet-catalog-host"))]
mod tests;

#[cfg(feature = "certified-subnet-catalog-host")]
pub use json::canonical_json_matches;
#[cfg(feature = "subnet-catalog-host")]
pub use json::canonical_json_sha256;
#[cfg(any(
    feature = "dashboard-host",
    feature = "icrc-host",
    feature = "subnet-catalog-host",
    feature = "sns-host"
))]
pub use json::write_managed_json_pretty_atomically;
#[cfg(feature = "subnet-catalog-host")]
pub use json::{canonical_json_serialized_len, json_error_to_io};
#[cfg(feature = "subnet-catalog-host")]
pub use output::{validate_output_path, write_text_output};
#[cfg(feature = "nns-host")]
pub use refresh::{RefreshCacheWriteRequest, RefreshCacheWriteResult, write_json_refresh_cache};

/// Reject an encoded managed file that exceeds its owner's read ceiling.
pub fn ensure_managed_write_size(
    path: &Path,
    length: u64,
    maximum: u64,
) -> Result<(), CacheFileError> {
    if length > maximum {
        return Err(CacheFileError::WriteLimitExceeded {
            path: path.to_path_buf(),
            maximum,
        });
    }
    Ok(())
}