canic-core 0.21.10

Canic — a canister orchestration and management toolkit for the Internet Computer
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use crate::access::AccessError;
use crate::dto::error::Error as PublicError;
use std::fmt;
use thiserror::Error as ThisError;

///
/// InternalError
///
/// Internal, structured error type.
///
/// This error:
/// - is NOT Candid-exposed
/// - is NOT stable across versions
/// - may evolve freely
///
/// All canister endpoints must convert this into a public error envelope
/// defined in dto/.
///

#[derive(Debug, ThisError)]
#[error("{message}")]
pub struct InternalError {
    class: InternalErrorClass,
    origin: InternalErrorOrigin,
    message: String,
    public_error: Option<PublicError>,
}

impl InternalError {
    pub fn new(
        class: InternalErrorClass,
        origin: InternalErrorOrigin,
        message: impl Into<String>,
    ) -> Self {
        Self {
            class,
            origin,
            message: message.into(),
            public_error: None,
        }
    }

    #[must_use]
    pub fn public(err: PublicError) -> Self {
        Self {
            class: InternalErrorClass::Domain,
            origin: InternalErrorOrigin::Domain,
            message: err.message.clone(),
            public_error: Some(err),
        }
    }

    pub fn domain(origin: InternalErrorOrigin, message: impl Into<String>) -> Self {
        Self::new(InternalErrorClass::Domain, origin, message)
    }

    pub fn invariant(origin: InternalErrorOrigin, message: impl Into<String>) -> Self {
        Self::new(InternalErrorClass::Invariant, origin, message)
    }

    pub fn infra(origin: InternalErrorOrigin, message: impl Into<String>) -> Self {
        Self::new(InternalErrorClass::Infra, origin, message)
    }

    pub fn ops(origin: InternalErrorOrigin, message: impl Into<String>) -> Self {
        Self::new(InternalErrorClass::Ops, origin, message)
    }

    pub fn workflow(origin: InternalErrorOrigin, message: impl Into<String>) -> Self {
        Self::new(InternalErrorClass::Workflow, origin, message)
    }

    #[must_use]
    pub const fn class(&self) -> InternalErrorClass {
        self.class
    }

    #[must_use]
    pub const fn origin(&self) -> InternalErrorOrigin {
        self.origin
    }

    #[must_use]
    pub const fn log_fields(&self) -> (InternalErrorClass, InternalErrorOrigin) {
        (self.class, self.origin)
    }

    #[must_use]
    pub const fn public_error(&self) -> Option<&PublicError> {
        self.public_error.as_ref()
    }
}

impl From<AccessError> for InternalError {
    fn from(err: AccessError) -> Self {
        Self::new(
            InternalErrorClass::Access,
            InternalErrorOrigin::Access,
            err.to_string(),
        )
    }
}

///
/// InternalErrorClass
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum InternalErrorClass {
    Access,
    Domain,
    Infra,
    Ops,
    Workflow,
    Invariant,
}

///
/// InternalErrorOrigin
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum InternalErrorOrigin {
    Access,
    Config,
    Domain,
    Infra,
    Ops,
    Storage,
    Workflow,
}

impl fmt::Display for InternalErrorClass {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let label = match self {
            Self::Access => "Access",
            Self::Domain => "Domain",
            Self::Infra => "Infra",
            Self::Ops => "Ops",
            Self::Workflow => "Workflow",
            Self::Invariant => "Invariant",
        };

        f.write_str(label)
    }
}

impl fmt::Display for InternalErrorOrigin {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let label = match self {
            Self::Access => "Access",
            Self::Config => "Config",
            Self::Domain => "Domain",
            Self::Infra => "Infra",
            Self::Ops => "Ops",
            Self::Storage => "Storage",
            Self::Workflow => "Workflow",
        };

        f.write_str(label)
    }
}