cli_prompts_rs 0.3.0

Easily build beautiful command-line apps
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

//! The error type for `CliPrompt` struct
//!
//! All public methods in `CliPrompt` returns `Result` with [`CliPromptError`]
use std::fmt::{Debug, Display, Formatter};
use std::io;
// TODO: add doc

/// A list specifying categories of error returned from [`call_spinner`](crate::CliPrompt::run_with_spinner)
#[derive(Debug)]
pub enum SpinnerError {
    /// This error will be returned when`task` is not finished within given time.
    TimedOut,
    /// `task` failed.
    TaskFailed,
}

/// A list specifying general categories of error from `CliPrompt` module.
#[derive(Debug)]
pub enum CliPromptError {
    /// Indicates an underlying IO Error.
    IoError(io::Error),
    /// The options vec is empty. Used for [`prompt_select`](crate::CliPrompt::prompt_select), [`prompt_multi_select`](crate::CliPrompt::prompt_multi_select)
    OptionsVecEmptyError { message: String },
    /// Used for [`prompt_multi_select_with_max_choice_num`](crate::CliPrompt::prompt_multi_select_with_max_choice_num)
    InvalidMaxChoiceNumError { message: String },
    /// Indicates an underlying Spinner Error.
    SpinnerError(SpinnerError),
}

impl From<io::Error> for CliPromptError {
    fn from(error: io::Error) -> Self {
        CliPromptError::IoError(error)
    }
}

impl Display for CliPromptError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            CliPromptError::IoError(io_error) => write!(f, "{}", io_error),
            CliPromptError::OptionsVecEmptyError { message } => write!(f, "{}", message),
            CliPromptError::InvalidMaxChoiceNumError { message } => write!(f, "{}", message),
            CliPromptError::SpinnerError(spinner_error) => spinner_error.fmt(f),
        }
    }
}

impl std::error::Error for CliPromptError {}