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

//! A crate for creating custom line-oriented command interpreters.
//!
//! # A tour of cmd
//!
//! cmd consists of three crates:
//! - cmd: Used for creating the cmd::Cmd struct that contains the CommandHandler implementations as in a HashMap
//! - command_handler: Contains the CommandHandler trait
//! - handlers: Contains ready-to-use Quit CommandHandler struct
//!
//! ## Example
//! ```rust
//! use std::io;
//! use std::io::Write;
//!
//! use rusty_cmd::command_handler::{CommandHandler, CommandResult};
//! use rusty_cmd::cmd::Cmd;
//! use rusty_cmd::handlers::Quit;
//!
//!
//! /// CommandHandler that prints out help message
//! #[derive(Debug, Default)]
//! pub struct Help;
//!
//! impl CommandHandler for Help {
//!     fn execute(&self, _stdout: &mut io::Stdout, _args: &[&str]) -> CommandResult {
//!         writeln!(_stdout, "Help message").unwrap();
//!         CommandResult::Continue
//!     }
//! }
//!
//! /// CommandHandler that emulates the basic bash touch command to create a new file
//! #[derive(Debug, Default)]
//! pub struct Touch;
//!
//! impl CommandHandler for Touch {
//!     fn execute(&self, _stdout: &mut io::Stdout, _args: &[&str]) -> CommandResult {
//!         let option_filename = _args.first();
//!     
//!         match option_filename {
//!             Some(filename) => {
//!                 let fs_result = std::fs::File::create(filename);
//!                 match fs_result {
//!                     Ok(file) => println!("Created file: {:?}", file),
//!                     Err(_) => println!("Could not create file: {}", filename),
//!                 }
//!             }
//!             None => println!("Need to specify a filename"),
//!         }
//!         CommandResult::Continue
//!     }
//! }
//!
//!
//! fn main() -> Result<(), std::io::Error>{
//!     let mut cmd = Cmd::new(
//!         io::BufReader::new(io::stdin()),
//!         io::stdout())
//!     ;
//!
//!     let help = Help::default();
//!     let hello = Touch::default();
//!     let quit = Quit::default();
//!
//!     cmd.add_cmd(String::from("help"), Box::new(help))?;
//!     cmd.add_cmd(String::from("touch"), Box::new(hello))?;
//!     cmd.add_cmd(String::from("quit"), Box::new(quit))?;
//!
//!     // cmd.run()?; uncommend to run cmd
//!
//!     Ok(())
//!
//! }
//! ```

/// Used for creating the cmd::Cmd struct that contains the CommandHandler implementations as in a HashMap.
pub mod cmd;

/// Contains the CommandHandler trait.
pub mod command_handler;

/// Contains common ready-to-use handlers
pub mod handlers;