Update docs to use new result & error

Author: pksunkara

CHANGELOG.md

@@ -7,6 +7,8 @@
 ### Breaking
 
 * Updated MSRV to `1.59.0`
+* Removed deprecated `Confirm::with_text`
+* Operations now return `dialouger::Result` instead of `std::io::Result`
 
 ## 0.10.4
 

examples/completion.rs

@@ -1,13 +1,15 @@
 use dialoguer::{theme::ColorfulTheme, Completion, Input};
 
-fn main() -> Result<(), std::io::Error> {
+fn main() {
     println!("Use the Right arrow or Tab to complete your command");
+
     let completion = MyCompletion::default();
+
     Input::<String>::with_theme(&ColorfulTheme::default())
         .with_prompt("dialoguer")
         .completion_with(&completion)
-        .interact_text()?;
-    Ok(())
+        .interact_text()
+        .unwrap();
 }
 
 struct MyCompletion {

src/edit.rs

@@ -1,11 +1,13 @@
 use std::{
     env,
     ffi::{OsStr, OsString},
-    fs, io,
+    fs,
     io::{Read, Write},
     process,
 };
 
+use crate::Result;
+
 /// Launches the default editor to edit a string.
 ///
 /// ## Example
@@ -88,7 +90,7 @@ impl Editor {
     ///
     /// Returns `None` if the file was not saved or otherwise the
     /// entered text.
-    pub fn edit(&self, s: &str) -> io::Result<Option<String>> {
+    pub fn edit(&self, s: &str) -> Result<Option<String>> {
         let mut f = tempfile::Builder::new()
             .prefix("edit-")
             .suffix(&self.extension)

src/lib.rs

@@ -31,23 +31,25 @@
 
 #![deny(clippy::all)]
 
+pub use console;
+
 #[cfg(feature = "completion")]
 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 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;

src/paging.rs

@@ -1,5 +1,3 @@
-use std::io;
-
 use console::Term;
 
 use crate::Result;
@@ -45,7 +43,7 @@ impl<'a> Paging<'a> {
     }
 
     /// Updates all internal based on the current terminal size and cursor position
-    pub fn update(&mut self, cursor_pos: usize) -> io::Result<()> {
+    pub fn update(&mut self, cursor_pos: usize) -> Result {
         let new_term_size = self.term.size();
 
         if self.current_term_size != new_term_size {

src/prompts/confirm.rs

@@ -1,26 +1,31 @@
 use std::io;
 
+use console::{Key, Term};
+
 use crate::{
     theme::{SimpleTheme, TermThemeRenderer, Theme},
     Result,
 };
 
-use console::{Key, Term};
-
 /// Renders a confirm prompt.
 ///
-/// ## Example usage
+/// ## Example
 ///
 /// ```rust,no_run
-/// # fn test() -> Result<(), Box<dyn std::error::Error>> {
 /// use dialoguer::Confirm;
 ///
-/// if Confirm::new().with_prompt("Do you want to continue?").interact()? {
-///     println!("Looks like you want to continue");
-/// } else {
-///     println!("nevermind then :(");
+/// fn main() {
+///     let confirmation = Confirm::new()
+///         .with_prompt("Do you want to continue?")
+///         .interact()
+///         .unwrap();
+///
+///     if confirmation {
+///         println!("Looks like you want to continue");
+///     } else {
+///         println!("nevermind then :(");
+///     }
 /// }
-/// # Ok(()) } fn main() { test().unwrap(); }
 /// ```
 pub struct Confirm<'a> {
     prompt: String,
@@ -38,7 +43,7 @@ impl Default for Confirm<'static> {
 }
 
 impl Confirm<'static> {
-    /// Creates a confirm prompt.
+    /// Creates a confirm prompt with default theme.
     pub fn new() -> Self {
         Self::with_theme(&SimpleTheme)
     }
@@ -59,12 +64,6 @@ impl Confirm<'_> {
         self
     }
 
-    #[deprecated(note = "Use with_prompt() instead", since = "0.6.0")]
-    #[inline]
-    pub fn with_text(&mut self, text: &str) -> &mut Self {
-        self.with_prompt(text)
-    }
-
     /// Sets when to react to user input.
     ///
     /// When `false` (default), we check on each user keystroke immediately as
@@ -114,52 +113,37 @@ 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) -> Result<Option<bool>> {
-        self.interact_on_opt(&Term::stderr())
-    }
-
-    /// Like [interact](#method.interact) but allows a specific terminal to be set.
     ///
-    /// ## Examples
+    /// ## Example
     ///
     /// ```rust,no_run
     /// use dialoguer::Confirm;
-    /// use console::Term;
     ///
-    /// # fn main() -> std::io::Result<()> {
-    /// let proceed = Confirm::new()
-    ///     .with_prompt("Do you wish to continue?")
-    ///     .interact_on(&Term::stderr())?;
-    /// #   Ok(())
-    /// # }
+    /// fn main() {
+    ///     let confirmation = Confirm::new()
+    ///         .interact_opt()
+    ///         .unwrap();
+    ///
+    ///     match confirmation {
+    ///         Some(answer) => println!("User answered {}", if answer { "yes" } else { "no " }),
+    ///         None => println!("User did not answer")
+    ///     }
+    /// }
     /// ```
     #[inline]
+    pub fn interact_opt(&self) -> Result<Option<bool>> {
+        self.interact_on_opt(&Term::stderr())
+    }
+
+    /// Like [`interact`](Self::interact) but allows a specific terminal to be set.
+    #[inline]
     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.
-    ///
-    /// ## Examples
-    /// ```rust,no_run
-    /// use dialoguer::Confirm;
-    /// use console::Term;
-    ///
-    /// fn main() -> std::io::Result<()> {
-    ///     let confirmation = Confirm::new()
-    ///         .interact_on_opt(&Term::stdout())?;
-    ///
-    ///     match confirmation {
-    ///         Some(answer) => println!("User answered {}", if answer { "yes" } else { "no " }),
-    ///         None => println!("User did not answer")
-    ///     }
-    ///
-    ///     Ok(())
-    /// }
-    /// ```
     #[inline]
     pub fn interact_on_opt(&self, term: &Term) -> Result<Option<bool>> {
         self._interact_on(term, true)
@@ -264,19 +248,16 @@ impl Confirm<'_> {
 impl<'a> Confirm<'a> {
     /// Creates a confirm prompt with a specific theme.
     ///
-    /// ## Examples
+    /// ## Example
+    ///
     /// ```rust,no_run
-    /// use dialoguer::{
-    ///     Confirm,
-    ///     theme::ColorfulTheme
-    /// };
+    /// use dialoguer::{theme::ColorfulTheme, Confirm};
     ///
-    /// # fn main() -> std::io::Result<()> {
-    /// let proceed = Confirm::with_theme(&ColorfulTheme::default())
-    ///     .with_prompt("Do you wish to continue?")
-    ///     .interact()?;
-    /// #    Ok(())
-    /// # }
+    /// fn main() {
+    ///     let confirmation = Confirm::with_theme(&ColorfulTheme::default())
+    ///         .interact()
+    ///         .unwrap();
+    /// }
     /// ```
     pub fn with_theme(theme: &'a dyn Theme) -> Self {
         Self {

src/prompts/fuzzy_select.rs

@@ -8,33 +8,26 @@ use crate::{
     Result,
 };
 
-/// Renders a selection menu that user can fuzzy match to reduce set.
+/// Renders a select prompt with fuzzy search.
 ///
 /// User can use fuzzy search to limit selectable items.
 /// Interaction returns index of an item selected in the order they appear in `item` invocation or `items` slice.
 ///
-/// ## Examples
+/// ## Example
 ///
 /// ```rust,no_run
-/// use dialoguer::{
-///     FuzzySelect,
-///     theme::ColorfulTheme
-/// };
-/// use console::Term;
+/// use dialoguer::FuzzySelect;
 ///
-/// fn main() -> std::io::Result<()> {
-///     let items = vec!["Item 1", "item 2"];
-///     let selection = FuzzySelect::with_theme(&ColorfulTheme::default())
-///         .items(&items)
-///         .default(0)
-///         .interact_on_opt(&Term::stderr())?;
+/// fn main() {
+///     let items = vec!["foo", "bar", "baz"];
 ///
-///     match selection {
-///         Some(index) => println!("User selected item : {}", items[index]),
-///         None => println!("User did not select anything")
-///     }
+///     let selection = FuzzySelect::new()
+///         .with_prompt("What do you choose?")
+///         .items(&items)
+///         .interact()
+///         .unwrap();
 ///
-///     Ok(())
+///     println!("You chose: {}", items[selection]);
 /// }
 /// ```
 
@@ -59,7 +52,7 @@ impl Default for FuzzySelect<'static> {
 }
 
 impl FuzzySelect<'static> {
-    /// Creates the prompt with a specific text.
+    /// Creates a fuzzy select prompt with default theme.
     pub fn new() -> Self {
         Self::with_theme(&SimpleTheme)
     }
@@ -138,7 +131,7 @@ impl FuzzySelect<'_> {
     /// The user can select the items using 'Enter' and the index of selected item will be returned.
     /// The dialog is rendered on stderr.
     /// 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'.
+    /// This unlike [`interact_opt`](Self::interact_opt) does not allow to quit with 'Esc' or 'q'.
     #[inline]
     pub fn interact(&self) -> Result<usize> {
         self.interact_on(&Term::stderr())
@@ -149,26 +142,45 @@ impl FuzzySelect<'_> {
     /// The user can select the items using 'Enter' and the index of selected item will be returned.
     /// The dialog is rendered on stderr.
     /// Result contains `Some(index)` if user hit 'Enter' or `None` if user cancelled with 'Esc' or 'q'.
+    ///
+    /// ## Example
+    ///
+    /// ```rust,no_run
+    /// use dialoguer::FuzzySelect;
+    ///
+    /// fn main() {
+    ///     let items = vec!["foo", "bar", "baz"];
+    ///
+    ///     let selection = FuzzySelect::new()
+    ///         .items(&items)
+    ///         .interact_opt()
+    ///         .unwrap();
+    ///
+    ///     match selection {
+    ///         Some(index) => println!("You chose: {}", items[index]),
+    ///         None => println!("You did not choose anything.")
+    ///     }
+    /// }
+    /// ```
     #[inline]
     pub fn interact_opt(&self) -> Result<Option<usize>> {
         self.interact_on_opt(&Term::stderr())
     }
 
-    /// Like `interact` but allows a specific terminal to be set.
+    /// Like [`interact`](Self::interact) but allows a specific terminal to be set.
     #[inline]
     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.
+    /// Like [`interact_opt`](Self::interact_opt) but allows a specific terminal to be set.
     #[inline]
     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) -> Result<Option<usize>> {
         // Place cursor at the end of the search term
         let mut position = self.initial_text.len();
@@ -315,7 +327,20 @@ impl FuzzySelect<'_> {
 }
 
 impl<'a> FuzzySelect<'a> {
-    /// Same as `new` but with a specific theme.
+    /// Creates a fuzzy select prompt with a specific theme.
+    ///
+    /// ## Example
+    ///
+    /// ```rust,no_run
+    /// use dialoguer::{theme::ColorfulTheme, FuzzySelect};
+    ///
+    /// fn main() {
+    ///     let selection = FuzzySelect::with_theme(&ColorfulTheme::default())
+    ///         .items(&["foo", "bar", "baz"])
+    ///         .interact()
+    ///         .unwrap();
+    /// }
+    /// ```
     pub fn with_theme(theme: &'a dyn Theme) -> Self {
         Self {
             default: None,