arcan-commands 0.3.0

Slash command system for the Arcan agent runtime
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

use crate::{Command, CommandContext, CommandResult};

pub struct HelpCommand;

impl Command for HelpCommand {
    fn name(&self) -> &str {
        "help"
    }

    fn aliases(&self) -> &[&str] {
        &["h", "?"]
    }

    fn description(&self) -> &str {
        "Show available slash commands"
    }

    fn execute(&self, _args: &str, ctx: &mut CommandContext) -> CommandResult {
        CommandResult::Output(ctx.help_text.clone())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn help_returns_help_text() {
        let cmd = HelpCommand;
        let mut ctx = CommandContext {
            help_text: "test help".to_string(),
            ..Default::default()
        };
        match cmd.execute("", &mut ctx) {
            CommandResult::Output(text) => assert_eq!(text, "test help"),
            other => panic!("expected Output, got {other:?}"),
        }
    }
}