nedots 0.1.7

A tool to manage configuration files/(ne)dots.
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

pub(crate) mod cmd;
pub(crate) mod errors;
pub(crate) mod models;
pub(crate) mod ops;
pub(crate) mod utils;

pub use cmd::nedots::RootCmd;

/// Implementors will take steps to `Initialize` before runtime. They return `T`
/// and `V` is passed to `init` and is required for valid `Initialization`.
pub trait Initialize<T, V> {
    /// Use args in order to initialize and return `T`.
    fn init(&self, args: &V) -> anyhow::Result<T>;
}

/// Implementors will `Run`. Shares similarities with `Execute`, but differs
/// because `exec` is typically called to `run` implementor so that the logical
/// scope of `Run` is constrained to its bare necessities.
pub trait Run {
    fn run(&self) -> anyhow::Result<()>;
}

pub trait RunWith<T> {
    fn run_with(&self, with: &T) -> anyhow::Result<()>;
}

pub trait Execute: clap::Args + Run {
    fn exec(&self) -> anyhow::Result<()> {
        self.run()
    }
}

/// Implementors will 'Execute' - they will run some code with the intent of
/// notifying the user during or after runtime.
pub trait ExecuteWith<T, V>: clap::Args + RunWith<V> {
    /// Execute with `T`, so `T` is passed to `exec` and is required for valid
    /// runtime.
    ///
    /// * `with`: `&T`, some data required for execution.
    fn exec_with(&self, with: &T) -> anyhow::Result<()>;
}

/// Marker trait.
pub trait BasicCommand {}