canic-core 0.110.2

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

use crate::{
    access::AccessError,
    diagnostics::{DiagnosticCode, RegisteredDiagnosticCode},
    dto::prelude::*,
};
use std::fmt::{self, Display};

///
/// Error
///
/// Public API error payload. Only registered runtime reasons may originate a
/// value; Candid/Serde decoding may still preserve any raw `u16`.
///

#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct Error {
    code: u16,
}

impl Error {
    /// Originate a public error from a registered reason.
    #[must_use]
    pub const fn from_registered(code: RegisteredDiagnosticCode) -> Self {
        Self {
            code: code.raw_code().raw(),
        }
    }

    /// Observe the lossless diagnostic identity.
    #[must_use]
    pub const fn code(&self) -> DiagnosticCode {
        DiagnosticCode::from_raw(self.code)
    }

    /// Observe the raw Candid `nat16` value.
    #[must_use]
    pub const fn raw_code(&self) -> u16 {
        self.code
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.code(), f)
    }
}

impl From<AccessError> for Error {
    fn from(err: AccessError) -> Self {
        match err {
            AccessError::Internal(error) => error.into(),
            error => {
                let diagnostic = error
                    .diagnostic_codes()
                    .expect("non-internal access errors have registered reasons");
                Self::from_registered(diagnostic.public)
            }
        }
    }
}