Console Utils

A Rust library for console-based user input, option selection, control, and more.

Overview

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:

[dependencies]
console-utils = "1.8.2"

After adding the dependency, you can import the modules you need in your Rust code. For example:

use console_utils::input::{input, select};
use console_utils::control::{flush, clear_line};

Examples

Reading User Input

use console_utils::input::{input, Empty};

// Read user input as a plain string
let text: String = input("Enter something: ");
println!("You entered: {}", text);

// Or read user input as a u8; returns Empty(None) if left blank.
let number: Empty<u8> = input("Enter a number (or press Enter to skip): ");
println!("You entered: {:?}", number);

Selecting Options

Single Option

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

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);

Text styling

use console_utils::styled::{StyledText, Color};

let text = StyledText::new("Hello, world!")
    .fg(Color::Red)
    .bg(Color::Black)
    .bold()
    .underline();

// Prints now a `Hello, world!` with red, bold and underlined text on a black background
println!("{}", text);

Console Control

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

use console_utils::read::{read_key};
// Cross-platform key reading
let key = read_key();
println!("Pressed key: {:?}", key);

Displaying a Spinner

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(&["1", "2", "3", "4", "3", "2"]));

Skippable Gradual String Reveal

use console_utils::{input::reveal, read::Key};

// Displays "Hello World!" with 0.1s between characters.
// Tip: Press/hold **Tab** to fast-forward the reveal by decreasing the time between characters to 0.001s.
reveal("Hello World!", 0.1, Some((Key::Tab, 0.001)));

For more detailed documentation, please refer to the generated Rust Docs.

console-utils 1.8.2