harmos-domain 0.1.7

Harmos domain model: identifiers, contracts, catalogs and storage identities.
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

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

/* === Modules === */

/* === Re-Exports === */

/* === Imports === */

// Standard Library Imports
use std::fmt;
// Third Party Imports
use serde::{Deserialize, Serialize};

// Local Imports
use crate::failure::{Failure, Origin};
use crate::operations;

/* === Constants === */

pub const RESERVED: &str = "harmos.";

pub const FAILED: i64 = -32_000;

pub const UNKNOWN: i64 = -32_601;

pub const UNREADABLE: i64 = -32_602;

/* === Macros === */

/* === Type Aliases === */

/* === Structs === */

// A host or carrier refusal: the JSON-RPC code beside the failure it carries.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Refusal {
    code: i64,
    failure: Failure,
}

/* === Enums === */

/* === Traits === */

/* === Implementations === */

impl Refusal {
    pub fn new(code: i64, message: impl fmt::Display) -> Self {
        let failure = Failure::new(operations::FailureKind::Permanent, message.to_string());
        Self::failed(code, failure)
    }

    pub fn of(cause: impl fmt::Display) -> Self {
        Self::new(FAILED, cause)
    }

    pub fn failed(code: i64, failure: Failure) -> Self {
        Self { code, failure }
    }

    // Refuses with the failure an error chain carries, or writes its cause.
    pub fn originate(
        code: i64, classification: operations::FailureKind, error: &(dyn std::error::Error + 'static), origin: Origin,
    ) -> Self {
        Self::failed(code, Failure::originate(classification, error, origin))
    }

    pub fn code(&self) -> i64 {
        self.code
    }

    pub fn message(&self) -> &str {
        self.failure.cause()
    }

    pub fn failure(&self) -> &Failure {
        &self.failure
    }

    pub fn into_failure(self) -> Failure {
        self.failure
    }
}

impl fmt::Display for Refusal {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        // A Refusal Is A Leaf: It Names The Operation Frame Beside Its Cause
        match self.failure.context().operation() {
            Some(operation) => write!(formatter, "operation `{operation}` failed: {} ({})", self.failure.cause(), self.code),
            None => write!(formatter, "{} ({})", self.failure.cause(), self.code),
        }
    }
}

impl std::error::Error for Refusal {}

/* === Public Functions === */

pub const fn reserved(method: &str) -> bool {
    let bytes = method.as_bytes();
    bytes.len() >= 7
        && bytes[0] == b'h'
        && bytes[1] == b'a'
        && bytes[2] == b'r'
        && bytes[3] == b'm'
        && bytes[4] == b'o'
        && bytes[5] == b's'
        && (bytes[6] == b'.' || bytes[6] == b'_')
}

/* === Private Functions === */

/* === Tests === */