✨ Major refactor && Change of input functions

Author: nwrenger

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "console-utils"
-version = "1.5.9"
+version = "1.6.0"
 edition = "2021"
 authors = ["Nils Wrenger <[email protected]>"]
 description = "Simple CLI Input and Control Utilities"

Cargo.toml

@@ -10,15 +10,13 @@ _A Rust library for console-based user input, option selection, control, and mor
 
 This crate offers utility functions for various console-related operations in Rust programs. From obtaining user input to achieving precise terminal control, its main focus is to remain simple while providing extensive functionality.
 
-
-
 ## Usage
 
 To use Console Utils in your Rust project, you can add the following dependency to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-console-utils = "1.5.9"
+console-utils = "1.6.0"
 ```
 
 After adding the dependency, you can import the modules you need in your Rust code. For example:
@@ -28,48 +26,85 @@ use console_utils::input::{input, select};
 use console_utils::control::{flush, clear_line};
 ```
 
-## Example
+## Examples
+
+### Reading User Input
+
+```rust, no_run
+use console_utils::input::input;
+// Read user input as a string
+let user_input: String = input("Enter something: ");
+
+println!("You entered: {}", user_input);
+```
+
+### Selecting Options
+
+#### Single Option
+```rust, no_run
+use console_utils::input::select;
+let options = [
+    "Option 1",
+    "Option 2",
+    "Option 3",
+];
+// Allow the user to select one option
+let selected_index = select("Select an option:", &options);
+
+println!("Selected option: {}", options[selected_index]);
+```
+
+#### Multiple Options
+```rust, no_run
+use console_utils::input::multiselect;
+let options = [
+    "Option 1",
+    "Option 2",
+    "Option 3",
+];
+// Allow the user to select multiple options
+let selected_indices = multiselect("Select options:", &options);
+
+println!("Selected indices: {:?}", selected_indices);
+```
+
+### Console Control
+
+```rust
+use console_utils::control::{flush, clear_line};
+// Flush the output buffer to ensure content is displayed immediately
+flush();
+// Clear the current line in the console
+clear_line();
+// and more...
+// Consult the docs for more details!
+```
+
+### Reading Key
+
+```rust, no_run
+use console_utils::read::{read_key};
+// Cross-platform key reading
+let key = read_key();
+println!("Pressed key: {:?}", key);
+```
+
+### Displaying a Spinner
+
+```rust
+use console_utils::input::{spinner, SpinnerType};
+// Display a standard spinner for 3 seconds
+spinner(3.0, SpinnerType::Standard);
+// Display a custom spinner for 2 seconds
+spinner(2.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]));
+```
+
+### Gradual String Reveal
 
 ```rust
-use console_utils::{input::{input, spinner, SpinnerType, select, reveal}, control::clear_line};
-
-fn main() {
-    // Read user input as a string
-    let user_input: Option<String> = input("Enter something: ", false);
-    
-    match user_input {
-        Some(value) => println!("You entered: {}", value),
-        None => panic!("Input cannot be None when 'allow_empty' is set to false."),
-    }
-
-    // Display a standard spinner for 3 seconds
-    spinner(3.0, SpinnerType::Standard);
-
-    // Cross-platform key reading
-    let key = read_key();
-
-    println!("Pressed key: {:?}", key);
-
-    let options = vec![
-        "Option 1",
-        "Option 2",
-        "Option 3",
-    ];
-
-    // Allow the user to select one option
-    let selected_indices = select("Select an option:", &options, false, false);
-
-    match selected_indices {
-        Some(indices) => println!("Selected indices: {:?}", indices),
-        None => panic!("The Options cannot be None, allow_empty is false."),
-    }
-    
-    // Display "Hello World!" with a time interval of 0.1 seconds between each character
-    reveal("Hello World!", 0.1);
-
-    // Clear the current line in the console, so the "Hello World!"
-    clear_line();
-}
+use console_utils::input::reveal;
+// Display "Hello World!" with a time interval of 0.1 seconds between each character
+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

@@ -5,15 +5,6 @@
 use std::io::{self, Write};
 
 /// Flushes the output buffer, ensuring that all content is written to the console.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::flush;
-///
-/// // Flush the output buffer to ensure content is displayed immediately
-/// flush();
-/// ```
 pub fn flush() {
     io::stdout().flush().unwrap();
 }
@@ -22,34 +13,47 @@ pub fn flush() {
 ///
 /// This function uses ANSI escape codes to clear the entire line and move the cursor to the
 /// beginning of the line.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::clear_line;
-///
-/// // Clear the current line
-/// clear_line();
-/// ```
 pub fn clear_line() {
     print!("\r\x1b[2K");
     flush();
 }
 
+/// Clears the `i` lines in the console.
+pub fn clear_lines(i: usize) {
+    for _ in 0..i {
+        print!("\r\x1b[2K");
+        flush();
+    }
+}
+
+/// Struct for ensuring and changing cursor visibility.
+pub struct Visibility;
+
+impl Visibility {
+    /// Hide the cursor via an ASCII escape sequence.
+    pub fn hide_cursor() {
+        print!("\x1B[?25l");
+        flush();
+    }
+
+    /// Show the cursor via an ASCII escape sequence.
+    pub fn show_cursor() {
+        print!("\x1B[?25h");
+        flush();
+    }
+}
+
+impl Drop for Visibility {
+    fn drop(&mut self) {
+        Visibility::show_cursor();
+    }
+}
+
 /// Moves the cursor down by the specified number of lines.
 ///
 /// # Arguments
 ///
 /// * `n` - The number of lines to move the cursor down.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::move_cursor_down;
-///
-/// // Move the cursor down by 2 lines
-/// move_cursor_down(2);
-/// ```
 pub fn move_cursor_down(n: usize) {
     if n > 0 {
         print!("\x1b[{}B", n);
@@ -62,15 +66,6 @@ pub fn move_cursor_down(n: usize) {
 /// # Arguments
 ///
 /// * `n` - The number of lines to move the cursor up.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::move_cursor_up;
-///
-/// // Move the cursor up by 3 lines
-/// move_cursor_up(3);
-/// ```
 pub fn move_cursor_up(n: usize) {
     if n > 0 {
         print!("\x1b[{}A", n);
@@ -83,15 +78,6 @@ pub fn move_cursor_up(n: usize) {
 /// # Arguments
 ///
 /// * `n` - The number of characters to move the cursor to the left.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::move_cursor_left;
-///
-/// // Move the cursor left by 4 characters
-/// move_cursor_left(4);
-/// ```
 pub fn move_cursor_left(n: usize) {
     if n > 0 {
         print!("\x1b[{}D", n);
@@ -104,15 +90,6 @@ pub fn move_cursor_left(n: usize) {
 /// # Arguments
 ///
 /// * `n` - The number of characters to move the cursor to the right.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::move_cursor_right;
-///
-/// // Move the cursor right by 5 characters
-/// move_cursor_right(5);
-/// ```
 pub fn move_cursor_right(n: usize) {
     if n > 0 {
         print!("\x1b[{}C", n);
@@ -126,15 +103,6 @@ pub fn move_cursor_right(n: usize) {
 ///
 /// * `x` - The horizontal position (column) to move the cursor to.
 /// * `y` - The vertical position (row) to move the cursor to.
-///
-/// # Example
-///
-/// ```rust
-/// use console_utils::control::move_cursor_to;
-///
-/// // Move the cursor to column 3, row 5
-/// move_cursor_to(3, 5);
-/// ```
 pub fn move_cursor_to(x: usize, y: usize) {
     print!("\x1B[{};{}H", y + 1, x + 1);
     flush();