shi 0.1.5

A Rust library for crafting shell interfaces.
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

use thiserror::Error;

#[derive(Error, Debug)]
#[non_exhaustive]
pub enum ShiError {
    #[error("readline error")]
    ReadlineError(#[from] rustyline::error::ReadlineError),
    #[error("expected a non-zero number of args, got none")]
    NoArgs,
    #[error("expected no args, but got {got:?}")]
    ExtraArgs { got: Vec<String> },
    #[error("invalid sub command, got {got} but expected {expected:?}")]
    InvalidSubCommand { got: String, expected: Vec<String> },
    #[error("unrecognized command: '{got}'")]
    UnrecognizedCommand { got: String },
    #[error("command already registered: {cmd}")]
    AlreadyRegistered { cmd: String },
    #[error("command failed to parse: {msg}")]
    ParseError {
        msg: String,
        possibilities: Vec<String>,
        cmd_path: Vec<String>,
        remaining: Vec<String>,
    },
    #[error("error: {msg}")]
    General { msg: String },
}

impl ShiError {
    pub fn general<S: AsRef<str>>(msg: S) -> ShiError {
        return ShiError::General {
            msg: msg.as_ref().to_string(),
        };
    }
}