libvault 0.2.2

the libvault is modified from RustyVault
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

//! RustyVault is consisted of many modules. Modules are the real components that implement the
//! features that users need. All modules in RustyVault are managed by `libvault::module_manager`.
//!
//! In details, the module manager is able to organize, add, remove, setup, initialize, cleanup
//! other RustyVault modules.
//!
//! Do not mix up the RustyVault module with the concept of a Rust module. A RustyVault module is a
//! piece of code that implements some functionality. Although usually that piece of code is
//! organized in the form of a module of crate `libvault` in Rust language concept.

use std::{any::Any, sync::Arc};

use arc_swap::ArcSwap;

use crate::{
    core::Core,
    errors::RvError,
    modules::{Module, system::SystemModule},
};

/// Manages RustyVault modules' lifecycle and registry.
///
/// `ModuleManager` holds a thread-safe, atomically-updatable list of
/// loaded modules and provides helper methods to add, remove, initialize
/// and query modules by name or type.
pub struct ModuleManager {
    /// Atomically-updated list of modules.
    pub modules: ArcSwap<Vec<Arc<dyn Module>>>,
}

impl ModuleManager {
    pub fn new() -> Self {
        Self {
            modules: ArcSwap::from_pointee(Vec::new()),
        }
    }

    pub fn set_default_modules(&self, core: Arc<Core>) -> Result<(), RvError> {
        let modules: Vec<Arc<dyn Module>> = vec![Arc::new(SystemModule::new(core))];
        self.modules.store(Arc::new(modules));
        Ok(())
    }

    /// Return a typed module handle by its registered `name`.
    ///
    /// This performs a downcast on the stored `Arc<dyn Module>` and returns
    /// `Some(Arc<T>)` on success.
    #[inline]
    pub fn get_module<T: Any + Send + Sync>(&self, name: &str) -> Option<Arc<T>> {
        let modules = self.modules.load();
        for m in modules.iter() {
            if m.name().as_str() == name {
                let any_arc = m.clone().as_any_arc();
                return Arc::downcast::<T>(any_arc).ok();
            }
        }

        None
    }

    #[inline]
    pub fn add_module(&self, module: Arc<dyn Module>) -> Result<(), RvError> {
        let modules = self.modules.load();
        for m in modules.iter() {
            if m.name().as_str() == module.name().as_str() {
                return Err(RvError::ErrModuleConflict);
            }
        }

        let old_modules = self.modules.load_full();
        let mut modules = (*old_modules).clone();
        modules.push(module);

        let modules = Arc::new(modules);

        if !Arc::ptr_eq(&self.modules.load().clone(), &old_modules) {
            return Err(RvError::ErrModuleConflict);
        }

        self.modules.store(modules);

        Ok(())
    }

    pub fn remove_module(&self, name: &str) -> Result<(), RvError> {
        let old_modules = self.modules.load_full();
        let mut modules = (*old_modules).clone();
        modules.retain(|m| m.name().as_str() != name);

        let modules = Arc::new(modules);

        if !Arc::ptr_eq(&self.modules.load().clone(), &old_modules) {
            return Err(RvError::ErrModuleConflict);
        }

        self.modules.store(modules);

        Ok(())
    }

    pub fn setup(&self, core: &Core) -> Result<(), RvError> {
        let modules = self.modules.load().clone();
        for module in modules.iter() {
            module.setup(core)?;
        }

        Ok(())
    }

    pub async fn init(&self, core: &Core) -> Result<(), RvError> {
        let modules = self.modules.load().clone();
        for module in modules.iter() {
            module.init(core).await?;
        }

        Ok(())
    }

    pub fn cleanup(&self, core: &Core) -> Result<(), RvError> {
        let modules = self.modules.load().clone();
        for module in modules.iter() {
            module.cleanup(core)?;
        }

        Ok(())
    }
}