ic-query 0.30.0

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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! Module: cache_file::json::errors
//!
//! Responsibility: map generic JSON cache load failures to owner errors.
//! Does not own: cache-file IO or command-specific error enums.
//! Boundary: defines the error-mapping trait used by shared cache loaders.

use crate::{CacheFileError, HostCacheError};
use std::path::PathBuf;

///
/// LoadJsonCacheErrorMapper
///
/// Maps shared JSON cache loading failures into command-family errors.
///

pub trait LoadJsonCacheErrorMapper {
    type Error;

    fn missing_cache(&self, path: PathBuf) -> Self::Error;
    /// Map a capability-rooted cache operation failure.
    fn cache_operation(&self, source: CacheFileError) -> Self::Error;
    fn parse_cache(&self, path: PathBuf, source: serde_json::Error) -> Self::Error;
    fn unsupported_schema(&self, version: u32, expected: u32) -> Self::Error;
    fn network_mismatch(&self, requested: String, actual: String) -> Self::Error;
}

///
/// HostJsonCacheErrorMapper
///
/// Maps generic JSON cache failures to the shared component-labelled host error.
///

#[cfg(any(feature = "icrc-host", feature = "nns-topology-host"))]
pub struct HostJsonCacheErrorMapper {
    component: &'static str,
}

#[cfg(any(feature = "icrc-host", feature = "nns-topology-host"))]
impl HostJsonCacheErrorMapper {
    pub const fn new(component: &'static str) -> Self {
        Self { component }
    }
}

#[cfg(any(feature = "icrc-host", feature = "nns-topology-host"))]
impl LoadJsonCacheErrorMapper for HostJsonCacheErrorMapper {
    type Error = HostCacheError;

    fn missing_cache(&self, path: PathBuf) -> Self::Error {
        HostCacheError::missing_cache(self.component, path)
    }

    fn cache_operation(&self, source: CacheFileError) -> Self::Error {
        HostCacheError::operation(self.component, source)
    }

    fn parse_cache(&self, path: PathBuf, source: serde_json::Error) -> Self::Error {
        HostCacheError::parse_cache(self.component, path, source)
    }

    fn unsupported_schema(&self, version: u32, expected: u32) -> Self::Error {
        HostCacheError::unsupported_cache_schema_version(self.component, version, expected)
    }

    fn network_mismatch(&self, requested: String, actual: String) -> Self::Error {
        HostCacheError::network_mismatch(self.component, requested, actual)
    }
}

///
/// OwnerJsonCacheErrorMapper
///
/// Preserves an owner-specific missing-cache error while routing every other
/// generic JSON cache failure through [`HostCacheError`].
///

#[cfg(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))]
pub struct OwnerJsonCacheErrorMapper<Error> {
    component: &'static str,
    missing_cache: fn(PathBuf) -> Error,
}

#[cfg(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))]
impl<Error> OwnerJsonCacheErrorMapper<Error> {
    /// Build one mapper for a component with specialized missing-cache guidance.
    pub const fn new(component: &'static str, missing_cache: fn(PathBuf) -> Error) -> Self {
        Self {
            component,
            missing_cache,
        }
    }
}

#[cfg(any(feature = "dashboard-host", feature = "nns-host", feature = "sns-host"))]
impl<Error> LoadJsonCacheErrorMapper for OwnerJsonCacheErrorMapper<Error>
where
    Error: From<HostCacheError>,
{
    type Error = Error;

    fn missing_cache(&self, path: PathBuf) -> Self::Error {
        (self.missing_cache)(path)
    }

    fn cache_operation(&self, source: CacheFileError) -> Self::Error {
        HostCacheError::operation(self.component, source).into()
    }

    fn parse_cache(&self, path: PathBuf, source: serde_json::Error) -> Self::Error {
        HostCacheError::parse_cache(self.component, path, source).into()
    }

    fn unsupported_schema(&self, version: u32, expected: u32) -> Self::Error {
        HostCacheError::unsupported_cache_schema_version(self.component, version, expected).into()
    }

    fn network_mismatch(&self, requested: String, actual: String) -> Self::Error {
        HostCacheError::network_mismatch(self.component, requested, actual).into()
    }
}