✨ Added reveal function

Author: nwrenger

Cargo.lock

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

Cargo.toml

@@ -82,4 +82,17 @@ spinner(1.5, SpinnerType::Box);
 spinner(2.0, SpinnerType::Flip);
 ```
 
+## Reveal Function
+
+Displays a string gradually, revealing one character at a time with a specified time interval between each character.
+
+### Usage
+
+```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(0.1, "Hello World!", true);
+```
+
 For more detailed documentation, please refer to the [generated Rust Docs](https://docs.rs/console-utils/latest/console_utils/).

README.md

@@ -1,4 +1,4 @@
-//! A simple library for console-based user input and option selection.
+//! A simple library for console-based user input, option selection and more.
 
 use console::{style, Key, Term};
 use std::{
@@ -251,3 +251,39 @@ pub fn spinner(mut time: f64, spinner_type: SpinnerType) {
     stdout.clear_line().unwrap();
     stdout.flush().unwrap();
 }
+
+/// Reveal Function
+///
+/// Displays a string gradually, revealing one character at a time with a specified time interval
+/// between each character.
+///
+/// # Arguments
+///
+/// * `time_between` - The time interval (in seconds) between each revealed character.
+/// * `str` - The string to reveal gradually.
+/// * `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(0.1, "Hello World!", true);
+/// ```
+pub fn reveal(time_between: f64, str: &str, new_line: bool) {
+    let stdout = Term::buffered_stdout();
+
+    for i in 0..str.len() {
+        stdout.clear_line().unwrap();
+        stdout.write_line(str.get(0..=i).unwrap()).unwrap();
+        stdout.move_cursor_up(1).unwrap();
+        stdout.move_cursor_right(i + 1).unwrap();
+        stdout.flush().unwrap();
+        thread::sleep(Duration::from_secs_f64(time_between));
+    }
+
+    if new_line {
+        println!();
+    }
+}

src/lib.rs

@@ -1,5 +1,5 @@
 // Import the functions to be tested from the crate root
-use console_utils::{input, select, spinner, SpinnerType};
+use console_utils::{input, reveal, select, spinner, SpinnerType};
 
 #[test]
 #[ignore]
@@ -33,3 +33,9 @@ fn test_spinner() {
     // Custom Spinner
     spinner(1.0, SpinnerType::Custom(vec!["1", "2", "3", "4", "3", "2"]))
 }
+
+#[test]
+fn test_reveal() {
+    // Give the fn the str and time, prints it delayed with a new line.
+    reveal(0.1, "Hello World!", true);
+}