clawsh 0.4.0

A shell built in rust for codecrafters
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

mod fs;
mod history;
mod invoke;
mod string;

use std::str::FromStr;
use thiserror::Error;

pub(crate) use invoke::invoke_builtin;

/// Constant array of the names of the built-in commands, used for autocompletion and `type` command
pub const BUILTIN_COMMANDS: [&str; 7] = ["echo", "exit", "type", "pwd", "cd", "history", "jobs"];

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Enum representing the commmands built into this shell
pub enum Builtin {
    /// Print arguments to stdout
    Echo,
    /// Exit the shell
    Exit,
    /// Display whether a command is builtin or where it is located on $PATH
    Tipe,
    /// Print working directory
    Pwd,
    /// Change directory
    Cd,
    /// Command for interacting with history
    /// # Subcommands
    ///
    /// - `history` — print all history
    /// - `history <n>` — print last `n` entries
    /// - `history -r <file>` — read history
    /// - `history -w <file>` — write history
    /// - `history -a <file>` — append history
    History,
    /// Command for interacting with jobs
    Jobs,
}

#[derive(Debug, Error, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum FromStrError {
    #[error("Unknown builtin {0}")]
    UnknownBuiltin(String),
}

impl FromStr for Builtin {
    type Err = FromStrError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "echo" => Ok(Builtin::Echo),
            "exit" => Ok(Builtin::Exit),
            "type" => Ok(Builtin::Tipe),
            "pwd" => Ok(Builtin::Pwd),
            "cd" => Ok(Builtin::Cd),
            "history" => Ok(Builtin::History),
            "jobs" => Ok(Builtin::Jobs),
            _ => Err(FromStrError::UnknownBuiltin(s.to_string())),
        }
    }
}