inquire 0.9.4

inquire is a library for building interactive prompts on terminals
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

//! Definitions of `inquire`'s error handling

use core::fmt;
use std::{error::Error, io};

/// Type alias to define errors that might be thrown by the library user
/// on callbacks such as validators.
pub type CustomUserError = Box<dyn Error + Send + Sync + 'static>;

/// Possible errors returned by `inquire` prompts.
#[derive(Debug)]
pub enum InquireError {
    /// The input device is not a TTY, which means that enabling raw mode
    /// on the terminal in order to listen to input events is not possible.
    NotTTY,

    /// The given prompt configuration is not valid. A detailed error message
    /// is contained in the value string.
    InvalidConfiguration(String),

    /// Error while executing IO operations.
    IO(io::Error),

    /// The user canceled the operation by pressing ESC.
    OperationCanceled,

    /// The operation was interrupted by the user after they
    /// pressed Ctrl+C.
    ///
    /// This error will be returned only when using `crossterm`
    /// or `termion` as the terminal back-end. If using `console`,
    /// pressing Ctrl+C will trigger SIGINT.
    OperationInterrupted,

    /// Error while executing IO operations.
    Custom(CustomUserError),
}

impl Error for InquireError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            InquireError::IO(err) => Some(err),
            InquireError::Custom(err) => Some(err.as_dyn_error()),
            _ => None,
        }
    }
}

trait AsDynError<'a> {
    fn as_dyn_error(&self) -> &(dyn Error + 'a);
}

impl<'a> AsDynError<'a> for dyn Error + Send + Sync + 'a {
    #[inline]
    fn as_dyn_error(&self) -> &(dyn Error + 'a) {
        self
    }
}

impl From<CustomUserError> for InquireError {
    fn from(err: CustomUserError) -> Self {
        InquireError::Custom(err)
    }
}

impl From<io::Error> for InquireError {
    fn from(err: io::Error) -> Self {
        match err.raw_os_error() {
            Some(25 | 6) => InquireError::NotTTY,
            _ => InquireError::IO(err),
        }
    }
}

impl fmt::Display for InquireError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            InquireError::NotTTY => f.write_str("The input device is not a TTY"),
            InquireError::InvalidConfiguration(s) => {
                write!(f, "The prompt configuration is invalid: {}", s)
            }
            InquireError::IO(err) => write!(f, "IO error: {}", err),
            InquireError::OperationCanceled => f.write_str("Operation was canceled by the user"),
            InquireError::OperationInterrupted => {
                f.write_str("Operation was interrupted by the user")
            }
            InquireError::Custom(err) => write!(f, "User-provided error: {}", err),
        }
    }
}

/// Result type where errors are of type [InquireError](crate::error::InquireError)
pub type InquireResult<T> = Result<T, InquireError>;