zino-core 0.43.1

Core types and traits for zino.
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

use crate::{
    BoxFuture,
    error::Error,
    extension::TomlTableExt,
    state::{Env, State},
};
use smallvec::SmallVec;
use toml::value::Table;

/// A custom plugin.
pub struct Plugin {
    /// Plugin name.
    name: &'static str,
    /// Plugin loader.
    loader: Option<BoxFuture<'static, Result<(), Error>>>,
    /// Running environments.
    environments: SmallVec<[Env; 2]>,
    /// Dependencies.
    dependencies: SmallVec<[&'static str; 2]>,
}

impl Plugin {
    /// Creates a new instance.
    #[inline]
    pub fn new(name: &'static str) -> Self {
        Self {
            name,
            loader: None,
            environments: SmallVec::new(),
            dependencies: SmallVec::new(),
        }
    }

    /// Creates a new instance with the loader.
    #[inline]
    pub fn with_loader(name: &'static str, loader: BoxFuture<'static, Result<(), Error>>) -> Self {
        Self {
            name,
            loader: Some(loader),
            environments: SmallVec::new(),
            dependencies: SmallVec::new(),
        }
    }

    /// Sets an asynchronous loader for the plugin.
    #[inline]
    pub fn set_loader(&mut self, loader: BoxFuture<'static, Result<(), Error>>) {
        self.loader = Some(loader);
    }

    /// Enables the running environment [`Env::Dev`].
    #[inline]
    pub fn enable_dev(&mut self) {
        if !self.environments.contains(&Env::Dev) {
            self.environments.push(Env::Dev);
        }
    }

    /// Enables the running environment [`Env::Prod`].
    #[inline]
    pub fn enable_prod(&mut self) {
        if !self.environments.contains(&Env::Prod) {
            self.environments.push(Env::Prod);
        }
    }

    /// Enables a running environment [`Env::Custom`].
    #[inline]
    pub fn enable(&mut self, env: &'static str) {
        let custom_env = Env::Custom(env);
        if !self.environments.contains(&custom_env) {
            self.environments.push(custom_env);
        }
    }

    /// Adds a dependency for the plugin.
    #[inline]
    pub fn add_dependency(&mut self, dependency: &'static str) {
        if !self.dependencies.contains(&dependency) {
            self.dependencies.push(dependency);
        }
    }

    /// Returns a reference to the shared config corresponding to the plugin.
    #[inline]
    pub fn get_config(&self) -> Option<&'static Table> {
        State::shared()
            .config()
            .get_table("plugins")?
            .get_table(self.name())
    }

    /// Returns the plugin name.
    #[inline]
    pub fn name(&self) -> &'static str {
        self.name
    }

    /// Returns the plugin dependencies.
    #[inline]
    pub fn dependencies(&self) -> &[&'static str] {
        self.dependencies.as_slice()
    }

    /// Returns `ture` if the running environment is enabled.
    #[inline]
    pub fn enabled(&self, env: &Env) -> bool {
        let environments = &self.environments;
        if environments.is_empty() {
            true
        } else {
            environments.contains(env)
        }
    }

    /// Loads the plugin.
    #[inline]
    pub async fn load(self) -> Result<(), Error> {
        if let Some(loader) = self.loader {
            loader.await
        } else {
            Ok(())
        }
    }
}