lefthk-core 0.3.2

A hotkey daemon for Adventurers
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

mod chord;
mod execute;
mod exit_chord;
mod kill;
mod reload;

pub mod utils;

use self::utils::{
    denormalize_function::DenormalizeCommandFunction, normalized_command::NormalizedCommand,
};
use crate::errors::{Error, LeftError, Result};
use crate::worker::Worker;

pub use self::{chord::Chord, execute::Execute, exit_chord::ExitChord, kill::Kill, reload::Reload};

inventory::collect!(DenormalizeCommandFunction);

/// When adding a command:
///  - a command has to submit itself to the inventory
///  - write a test that it's conversion between normalizel and denormalize works
pub trait Command: std::fmt::Debug {
    fn normalize(&self) -> NormalizedCommand;

    fn denormalize(generalized: &NormalizedCommand) -> Option<Box<Self>>
    where
        Self: Sized;

    /// # Errors
    ///
    /// This errors when the command cannot be executed by the worker
    fn execute(&self, worker: &mut Worker) -> Error;

    fn get_name(&self) -> &'static str;
}

/// # Errors
///
/// This errors when the command cannot be matched with the known commands
pub fn denormalize(normalized_command: &NormalizedCommand) -> Result<Box<dyn Command>> {
    for denormalizer in inventory::iter::<DenormalizeCommandFunction> {
        if let Some(denormalized_command) = (denormalizer.0)(normalized_command) {
            return Ok(denormalized_command);
        }
    }
    Err(LeftError::UnmatchingCommand)
}