Introduce error

Author: pksunkara

Cargo.toml

@@ -30,6 +30,7 @@ tempfile = { version = "3", optional = true }
 zeroize = { version = "1.1.1", optional = true }
 fuzzy-matcher = { version = "0.3.7", optional = true }
 shell-words = "1.1.0"
+thiserror = "1.0.40"
 
 [[example]]
 name = "password"

src/error.rs

@@ -0,0 +1,14 @@
+use std::{io::Error as IoError, result::Result as StdResult};
+
+use thiserror::Error;
+
+/// Possible errors returned by prompts.
+#[derive(Error, Debug)]
+pub enum Error {
+    /// Error while executing IO operations.
+    #[error("IO error: {0}")]
+    IO(#[from] IoError),
+}
+
+/// Result type where errors are of type [Error](crate::error::Error)
+pub type Result<T = ()> = StdResult<T, Error>;

src/lib.rs

@@ -36,24 +36,24 @@ pub use completion::Completion;
 pub use console;
 #[cfg(feature = "editor")]
 pub use edit::Editor;
+pub use error::{Error, Result};
 #[cfg(feature = "history")]
 pub use history::History;
 use paging::Paging;
-pub use prompts::{
-    confirm::Confirm, input::Input, multi_select::MultiSelect, select::Select, sort::Sort,
-};
-pub use validate::Validator;
-
 #[cfg(feature = "fuzzy-select")]
 pub use prompts::fuzzy_select::FuzzySelect;
-
 #[cfg(feature = "password")]
 pub use prompts::password::Password;
+pub use prompts::{
+    confirm::Confirm, input::Input, multi_select::MultiSelect, select::Select, sort::Sort,
+};
+pub use validate::Validator;
 
 #[cfg(feature = "completion")]
 mod completion;
 #[cfg(feature = "editor")]
 mod edit;
+mod error;
 #[cfg(feature = "history")]
 mod history;
 mod paging;

src/paging.rs

@@ -2,6 +2,8 @@ use std::io;
 
 use console::Term;
 
+use crate::Result;
+
 /// Creates a paging module
 ///
 /// The paging module serves as tracking structure to allow paged views
@@ -78,9 +80,9 @@ impl<'a> Paging<'a> {
     /// Renders a prompt when the following conditions are met:
     /// * Paging is active
     /// * Transition of the paging activity happened (active -> inactive / inactive -> active)
-    pub fn render_prompt<F>(&mut self, mut render_prompt: F) -> io::Result<()>
+    pub fn render_prompt<F>(&mut self, mut render_prompt: F) -> Result
     where
-        F: FnMut(Option<(usize, usize)>) -> io::Result<()>,
+        F: FnMut(Option<(usize, usize)>) -> Result,
     {
         if self.active {
             let paging_info = Some((self.current_page + 1, self.pages));

src/prompts/confirm.rs

@@ -1,6 +1,9 @@
 use std::io;
 
-use crate::theme::{SimpleTheme, TermThemeRenderer, Theme};
+use crate::{
+    theme::{SimpleTheme, TermThemeRenderer, Theme},
+    Result,
+};
 
 use console::{Key, Term};
 
@@ -101,7 +104,7 @@ impl Confirm<'_> {
     /// Result contains `bool` if user answered "yes" or "no" or `default` (configured in [`default`](Self::default) if pushes enter.
     /// This unlike [`interact_opt`](Self::interact_opt) does not allow to quit with 'Esc' or 'q'.
     #[inline]
-    pub fn interact(&self) -> io::Result<bool> {
+    pub fn interact(&self) -> Result<bool> {
         self.interact_on(&Term::stderr())
     }
 
@@ -112,7 +115,7 @@ impl Confirm<'_> {
     /// Result contains `Some(bool)` if user answered "yes" or "no" or `Some(default)` (configured in [`default`](Self::default)) if pushes enter,
     /// or `None` if user cancelled with 'Esc' or 'q'.
     #[inline]
-    pub fn interact_opt(&self) -> io::Result<Option<bool>> {
+    pub fn interact_opt(&self) -> Result<Option<bool>> {
         self.interact_on_opt(&Term::stderr())
     }
 
@@ -132,9 +135,10 @@ impl Confirm<'_> {
     /// # }
     /// ```
     #[inline]
-    pub fn interact_on(&self, term: &Term) -> io::Result<bool> {
-        self._interact_on(term, false)?
-            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))
+    pub fn interact_on(&self, term: &Term) -> Result<bool> {
+        Ok(self
+            ._interact_on(term, false)?
+            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))?)
     }
 
     /// Like [`interact_opt`](Self::interact_opt) but allows a specific terminal to be set.
@@ -157,11 +161,11 @@ impl Confirm<'_> {
     /// }
     /// ```
     #[inline]
-    pub fn interact_on_opt(&self, term: &Term) -> io::Result<Option<bool>> {
+    pub fn interact_on_opt(&self, term: &Term) -> Result<Option<bool>> {
         self._interact_on(term, true)
     }
 
-    fn _interact_on(&self, term: &Term, allow_quit: bool) -> io::Result<Option<bool>> {
+    fn _interact_on(&self, term: &Term, allow_quit: bool) -> Result<Option<bool>> {
         let mut render = TermThemeRenderer::new(term, self.theme);
 
         let default_if_show = if self.show_default {
@@ -210,7 +214,7 @@ impl Confirm<'_> {
                         return Err(io::Error::new(
                             io::ErrorKind::NotConnected,
                             "Not a terminal",
-                        ))
+                        ))?;
                     }
                     _ => {
                         continue;
@@ -234,7 +238,7 @@ impl Confirm<'_> {
                         return Err(io::Error::new(
                             io::ErrorKind::NotConnected,
                             "Not a terminal",
-                        ))
+                        ))?;
                     }
                     _ => {
                         continue;

src/prompts/fuzzy_select.rs

@@ -1,7 +1,12 @@
-use crate::theme::{SimpleTheme, TermThemeRenderer, Theme};
+use std::{io, ops::Rem};
+
 use console::{Key, Term};
 use fuzzy_matcher::FuzzyMatcher;
-use std::{io, ops::Rem};
+
+use crate::{
+    theme::{SimpleTheme, TermThemeRenderer, Theme},
+    Result,
+};
 
 /// Renders a selection menu that user can fuzzy match to reduce set.
 ///
@@ -135,7 +140,7 @@ impl FuzzySelect<'_> {
     /// Result contains `index` of selected item if user hit 'Enter'.
     /// This unlike [interact_opt](#method.interact_opt) does not allow to quit with 'Esc' or 'q'.
     #[inline]
-    pub fn interact(&self) -> io::Result<usize> {
+    pub fn interact(&self) -> Result<usize> {
         self.interact_on(&Term::stderr())
     }
 
@@ -145,25 +150,26 @@ impl FuzzySelect<'_> {
     /// The dialog is rendered on stderr.
     /// Result contains `Some(index)` if user hit 'Enter' or `None` if user cancelled with 'Esc' or 'q'.
     #[inline]
-    pub fn interact_opt(&self) -> io::Result<Option<usize>> {
+    pub fn interact_opt(&self) -> Result<Option<usize>> {
         self.interact_on_opt(&Term::stderr())
     }
 
     /// Like `interact` but allows a specific terminal to be set.
     #[inline]
-    pub fn interact_on(&self, term: &Term) -> io::Result<usize> {
-        self._interact_on(term, false)?
-            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))
+    pub fn interact_on(&self, term: &Term) -> Result<usize> {
+        Ok(self
+            ._interact_on(term, false)?
+            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))?)
     }
 
     /// Like `interact` but allows a specific terminal to be set.
     #[inline]
-    pub fn interact_on_opt(&self, term: &Term) -> io::Result<Option<usize>> {
+    pub fn interact_on_opt(&self, term: &Term) -> Result<Option<usize>> {
         self._interact_on(term, true)
     }
 
     /// Like `interact` but allows a specific terminal to be set.
-    fn _interact_on(&self, term: &Term, allow_quit: bool) -> io::Result<Option<usize>> {
+    fn _interact_on(&self, term: &Term, allow_quit: bool) -> Result<Option<usize>> {
         // Place cursor at the end of the search term
         let mut position = self.initial_text.len();
         let mut search_term = self.initial_text.to_owned();

src/prompts/input.rs

@@ -1,4 +1,6 @@
-use std::{cmp::Ordering, fmt::Debug, io, iter, str::FromStr};
+use std::{cmp::Ordering, fmt::Debug, iter, str::FromStr};
+
+use console::{Key, Term};
 
 #[cfg(feature = "completion")]
 use crate::completion::Completion;
@@ -7,10 +9,9 @@ use crate::history::History;
 use crate::{
     theme::{SimpleTheme, TermThemeRenderer, Theme},
     validate::Validator,
+    Result,
 };
 
-use console::{Key, Term};
-
 type ValidatorCallback<'a, T> = Box<dyn FnMut(&T) -> Option<String> + 'a>;
 
 /// Renders an input prompt.
@@ -264,12 +265,12 @@ where
     /// while [`interact`](#method.interact) allows virtually any character to be used e.g arrow keys.
     ///
     /// The dialog is rendered on stderr.
-    pub fn interact_text(&mut self) -> io::Result<T> {
+    pub fn interact_text(&mut self) -> Result<T> {
         self.interact_text_on(&Term::stderr())
     }
 
     /// Like [`interact_text`](#method.interact_text) but allows a specific terminal to be set.
-    pub fn interact_text_on(&mut self, term: &Term) -> io::Result<T> {
+    pub fn interact_text_on(&mut self, term: &Term) -> Result<T> {
         let mut render = TermThemeRenderer::new(term, self.theme);
 
         loop {
@@ -615,12 +616,12 @@ where
     ///
     /// If the user confirms the result is `true`, `false` otherwise.
     /// The dialog is rendered on stderr.
-    pub fn interact(&mut self) -> io::Result<T> {
+    pub fn interact(&mut self) -> Result<T> {
         self.interact_on(&Term::stderr())
     }
 
     /// Like [`interact`](#method.interact) but allows a specific terminal to be set.
-    pub fn interact_on(&mut self, term: &Term) -> io::Result<T> {
+    pub fn interact_on(&mut self, term: &Term) -> Result<T> {
         let mut render = TermThemeRenderer::new(term, self.theme);
 
         loop {

src/prompts/multi_select.rs

@@ -1,12 +1,12 @@
 use std::{io, iter::repeat, ops::Rem};
 
+use console::{Key, Term};
+
 use crate::{
     theme::{SimpleTheme, TermThemeRenderer, Theme},
-    Paging,
+    Paging, Result,
 };
 
-use console::{Key, Term};
-
 /// Renders a multi select prompt.
 ///
 /// ## Example usage
@@ -132,7 +132,7 @@ impl MultiSelect<'_> {
     /// Result contains `Vec<index>` if user hit 'Enter'.
     /// This unlike [`interact_opt`](Self::interact_opt) does not allow to quit with 'Esc' or 'q'.
     #[inline]
-    pub fn interact(&self) -> io::Result<Vec<usize>> {
+    pub fn interact(&self) -> Result<Vec<usize>> {
         self.interact_on(&Term::stderr())
     }
 
@@ -142,7 +142,7 @@ impl MultiSelect<'_> {
     /// The dialog is rendered on stderr.
     /// Result contains `Some(Vec<index>)` if user hit 'Enter' or `None` if user cancelled with 'Esc' or 'q'.
     #[inline]
-    pub fn interact_opt(&self) -> io::Result<Option<Vec<usize>>> {
+    pub fn interact_opt(&self) -> Result<Option<Vec<usize>>> {
         self.interact_on_opt(&Term::stderr())
     }
 
@@ -165,9 +165,10 @@ impl MultiSelect<'_> {
     /// }
     ///```
     #[inline]
-    pub fn interact_on(&self, term: &Term) -> io::Result<Vec<usize>> {
-        self._interact_on(term, false)?
-            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))
+    pub fn interact_on(&self, term: &Term) -> Result<Vec<usize>> {
+        Ok(self
+            ._interact_on(term, false)?
+            .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "Quit not allowed in this case"))?)
     }
 
     /// Like [`interact_opt`](Self::interact_opt) but allows a specific terminal to be set.
@@ -192,16 +193,16 @@ impl MultiSelect<'_> {
     /// }
     /// ```
     #[inline]
-    pub fn interact_on_opt(&self, term: &Term) -> io::Result<Option<Vec<usize>>> {
+    pub fn interact_on_opt(&self, term: &Term) -> Result<Option<Vec<usize>>> {
         self._interact_on(term, true)
     }
 
-    fn _interact_on(&self, term: &Term, allow_quit: bool) -> io::Result<Option<Vec<usize>>> {
+    fn _interact_on(&self, term: &Term, allow_quit: bool) -> Result<Option<Vec<usize>>> {
         if self.items.is_empty() {
             return Err(io::Error::new(
                 io::ErrorKind::Other,
                 "Empty list of items given to `MultiSelect`",
-            ));
+            ))?;
         }
 
         let mut paging = Paging::new(term, self.items.len(), self.max_length);

src/prompts/password.rs

@@ -1,13 +1,12 @@
-use std::io;
+use console::Term;
+use zeroize::Zeroizing;
 
 use crate::{
     theme::{SimpleTheme, TermThemeRenderer, Theme},
     validate::PasswordValidator,
+    Result,
 };
 
-use console::Term;
-use zeroize::Zeroizing;
-
 type PasswordValidatorCallback<'a> = Box<dyn Fn(&String) -> Option<String> + 'a>;
 
 /// Renders a password input prompt.
@@ -124,12 +123,12 @@ impl<'a> Password<'a> {
     ///
     /// If the user confirms the result is `true`, `false` otherwise.
     /// The dialog is rendered on stderr.
-    pub fn interact(&self) -> io::Result<String> {
+    pub fn interact(&self) -> Result<String> {
         self.interact_on(&Term::stderr())
     }
 
     /// Like `interact` but allows a specific terminal to be set.
-    pub fn interact_on(&self, term: &Term) -> io::Result<String> {
+    pub fn interact_on(&self, term: &Term) -> Result<String> {
         let mut render = TermThemeRenderer::new(term, self.theme);
         render.set_prompts_reset_height(false);
 
@@ -163,7 +162,7 @@ impl<'a> Password<'a> {
         }
     }
 
-    fn prompt_password(&self, render: &mut TermThemeRenderer, prompt: &str) -> io::Result<String> {
+    fn prompt_password(&self, render: &mut TermThemeRenderer, prompt: &str) -> Result<String> {
         loop {
             render.password_prompt(prompt)?;
             render.term().flush()?;