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
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

//! # nut-shell
//!
//! Lightweight CLI library for embedded systems with zero heap allocation.
//!
//! **Key features:**
//! - **Static allocation** - Everything lives in ROM, zero heap usage
//! - **Const initialization** - Command trees defined at compile time
//! - **Optional features** - Authentication, tab completion, command history, async
//! - **Flexible I/O** - Platform-agnostic character I/O trait
//! - **Access control** - Hierarchical permissions with generic access levels
//!
//! See EXAMPLES.md for complete usage patterns.
//!
//! ## Optional Features
//!
//! - `authentication` - User login/logout, password hashing, credential providers
//! - `completion` - Tab completion for commands and paths
//! - `history` - Command history with up/down arrow navigation
//! - `async` - Async command execution support
//!
//! The library provides a `#[derive(AccessLevel)]` macro that's always available.
//!
//! This library is `no_std` compatible.

#![no_std]
#![warn(missing_docs)]
#![warn(missing_debug_implementations)]
#![allow(clippy::result_large_err)]

extern crate heapless;

// Optional dependencies (feature-gated)
#[cfg(feature = "authentication")]
extern crate sha2;

#[cfg(feature = "authentication")]
extern crate subtle;

// Re-export derive macro (always available)
pub use nut_shell_macros::AccessLevel;

// ============================================================================
// Module Declarations
// ============================================================================

// I/O & Access Control Foundation
pub mod config;
pub mod io;

// Authentication module (always present, but with different contents based on features)
pub mod auth;

// Error handling
pub mod error;

// Tree data model
pub mod tree;

// Response types
pub mod response;

// Shell orchestration
pub mod shell;

// ============================================================================
// Re-exports - Public API
// ============================================================================

// Core I/O
pub use io::CharIo;

// Configuration
pub use config::{DefaultConfig, MinimalConfig, ShellConfig};

// Error types
pub use error::CliError;

// Tree types
pub use tree::{CommandKind, CommandMeta, Directory, Node};

// Access control (always available, even without authentication feature)
pub use auth::{AccessLevel, User};

// Response types
pub use response::Response;

// Shell types
pub use shell::handler::CommandHandler;
pub use shell::{CliState, HistoryDirection, Request, Shell};

// Optional feature re-exports (authentication-only types)
#[cfg(feature = "authentication")]
pub use auth::{ConstCredentialProvider, CredentialProvider, PasswordHasher, Sha256Hasher};

// ============================================================================
// Library Metadata
// ============================================================================

/// Library version
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Library name
pub const NAME: &str = env!("CARGO_PKG_NAME");

// ============================================================================
// Tests
// ============================================================================

#[cfg(test)]
mod tests {
    // No tests needed - all public APIs tested in their respective modules
}