appcore-contracts 2.0.0-alpha.1

Stable, implementation-independent manifests and distributed runtime contracts for AppCore.
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

// =============================================================================
//        #######
//     ###       ###     F: module.rs
//    ##   ## ##   ##    P: AppCore-Runtime
//         ## ##
//                       C: 2026/07/22 15:41:18 by dnettoRaw
//    ##   ## ##   ##    U: 2026/07/22 15:41:18 by dnettoRaw
//      ###########      S: 1.0.1-rc.8
// =============================================================================

use super::*;

/// Application module declaration.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ModuleDeclaration {
    id: ModuleId,
    version: String,
    required: bool,
}

impl ModuleDeclaration {
    /// Creates an application module declaration.
    pub fn new(id: ModuleId, version: impl Into<String>, required: bool) -> ContractResult<Self> {
        let module = Self {
            id,
            version: version.into(),
            required,
        };
        module.validate()?;
        Ok(module)
    }

    /// Returns the module identity.
    pub fn id(&self) -> &ModuleId {
        &self.id
    }

    /// Returns the module version.
    pub fn version(&self) -> &str {
        &self.version
    }

    /// Reports whether the module is required.
    pub fn is_required(&self) -> bool {
        self.required
    }

    pub(crate) fn validate(&self) -> ContractResult<()> {
        validate_text("module.version", &self.version, 64)
    }
}