nut-shell 0.1.2

A lightweight command-line interface library for embedded systems
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

//! Command handler trait for executing commands.
//!
//! Maps command IDs to execution functions, implementing the execution side
//! of the metadata/execution separation pattern.

use crate::config::ShellConfig;
use crate::error::CliError;
use crate::response::Response;

/// Command execution handler trait.
/// Maps command IDs to execution functions (dispatches on unique ID, not display name).
pub trait CommandHandler<C: ShellConfig> {
    /// Execute synchronous command by unique ID.
    fn execute_sync(&self, id: &str, args: &[&str]) -> Result<Response<C>, CliError>;

    /// Execute asynchronous command by unique ID (requires `async` feature).
    /// Uses `async fn` without Send bounds for both single and multi-threaded executors.
    #[cfg(feature = "async")]
    #[allow(async_fn_in_trait)]
    async fn execute_async(&self, id: &str, args: &[&str]) -> Result<Response<C>, CliError>;
}

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

    // Mock handler for testing
    struct TestHandler;

    impl CommandHandler<DefaultConfig> for TestHandler {
        fn execute_sync(
            &self,
            id: &str,
            _args: &[&str],
        ) -> Result<Response<DefaultConfig>, CliError> {
            match id {
                "test" => Ok(Response::success("OK")),
                _ => Err(CliError::CommandNotFound),
            }
        }

        #[cfg(feature = "async")]
        async fn execute_async(
            &self,
            id: &str,
            _args: &[&str],
        ) -> Result<Response<DefaultConfig>, CliError> {
            match id {
                "async-test" => Ok(Response::success("Async OK")),
                _ => Err(CliError::CommandNotFound),
            }
        }
    }

    #[test]
    fn test_sync_handler() {
        let handler = TestHandler;
        let result = handler.execute_sync("test", &[]);
        assert!(result.is_ok());
        assert_eq!(result.unwrap().message.as_str(), "OK");

        let result = handler.execute_sync("unknown", &[]);
        assert_eq!(result, Err(CliError::CommandNotFound));
    }

    #[cfg(feature = "async")]
    #[tokio::test]
    async fn test_async_handler() {
        let handler = TestHandler;
        let result = handler.execute_async("async-test", &[]).await;
        assert!(result.is_ok());
        assert_eq!(result.unwrap().message.as_str(), "Async OK");

        let result = handler.execute_async("unknown", &[]).await;
        assert_eq!(result, Err(CliError::CommandNotFound));
    }
}