✨ Refactored input and reveal function

Author: nwrenger

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "console-utils"
-version = "1.2.2"
+version = "1.2.3"
 edition = "2021"
 authors = ["Nils Wrenger <[email protected]>"]
 description = "Cli input utilities."

Cargo.toml

@@ -16,7 +16,7 @@ use console_utils::input;
 
 fn main() {
     // Prompt the user for input
-    let user_input = input::<String>("Enter something: ", false, false);
+    let user_input = input::<String>("Enter something: ", false);
 
     // Process the user input
     match user_input {
@@ -92,7 +92,7 @@ Displays a string gradually, revealing one character at a time with a specified
 use console_utils::reveal;
 
 // Display "Hello World!" with a time interval of 0.1 seconds between each character and a new line after it's finished.
-reveal("Hello World!", 0.1, true);
+reveal("Hello World!", 0.1);
 ```
 
 For more detailed documentation, please refer to the [generated Rust Docs](https://docs.rs/console-utils/latest/console_utils/).

README.md

@@ -15,9 +15,8 @@ use std::{
 ///
 /// # Arguments
 ///
-/// * `before` - The text to display before prompting for input.
+/// * `before` - The text to display before prompting for input. Add here `\n` for a new line.
 /// * `allow_empty` - If true, allows the input to be empty.
-/// * `new_line` - If true, adds a newline character after the prompt.
 ///
 /// # Returns
 ///
@@ -29,20 +28,20 @@ use std::{
 /// ```no_run
 /// use console_utils::input;
 ///     
-/// let user_input = input::<String>("Enter something: ", false, false);
+/// let user_input = input::<String>("Enter something: ", false);
 ///
 /// match user_input {
 ///     Some(value) => println!("You entered: {}", value),
 ///     None => panic!("The Input cannot be None, allow_empty is false."),
 /// }
 /// ```
-pub fn input<T>(before: &str, allow_empty: bool, new_line: bool) -> Option<T>
+pub fn input<T>(before: &str, allow_empty: bool) -> Option<T>
 where
     T: std::str::FromStr,
     T::Err: std::fmt::Debug,
 {
     loop {
-        print!("{before} {}", if new_line { '\n' } else { '\0' });
+        print!("{before}");
         io::stdout().flush().unwrap();
 
         let mut cli = String::new();
@@ -259,26 +258,21 @@ pub fn spinner(mut time: f64, spinner_type: SpinnerType) {
 ///
 /// # Arguments
 ///
-/// * `str` - The string to reveal gradually.
+/// * `str` - The string to reveal gradually. Add here `\n` for a new line.
 /// * `time_between` - The time interval (in seconds) between each revealed character.
-/// * `new_line` - If true, adds a newline character after the revelation.
 ///
 /// # Example
 ///
 /// ```rust
 /// use console_utils::reveal;
 ///
 /// // Display "Hello World!" with a time interval of 0.1 seconds between each character and a new line after it's finished.
-/// reveal("Hello World!", 0.1, true);
+/// reveal("Hello World!", 0.1);
 /// ```
-pub fn reveal(str: &str, time_between: f64, new_line: bool) {
+pub fn reveal(str: &str, time_between: f64) {
     for i in 0..str.len() {
-        print!("{}", str.chars().nth(i).unwrap());
+        print!("{:?}", str.chars().nth(i).unwrap());
         io::stdout().flush().unwrap();
         thread::sleep(Duration::from_secs_f64(time_between));
     }
-
-    if new_line {
-        println!();
-    }
 }

src/lib.rs

@@ -5,7 +5,7 @@ use console_utils::{input, reveal, select, spinner, SpinnerType};
 #[ignore]
 fn test_input() {
     // Run the function
-    let result = input::<u8>("Enter something: ", false, false);
+    let result = input::<u8>("Enter something: ", false);
 
     // Input anything
 
@@ -36,6 +36,6 @@ fn test_spinner() {
 
 #[test]
 fn test_reveal() {
-    // Give the fn the str and time, prints it delayed with a new line.
-    reveal("Hello World!", 0.1, true);
+    // Give the fn the str and time.
+    reveal("Hello World!\n", 0.1);
 }