Adding `setup_console` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add setup-console

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

setup-console = "0.2.1"

The setup_console library will be automatically available globally. Read the setup_console library documentation.

Back to the crate overview.

Readme

setup-console

A library that provides a function to fix ANSI escaping problem in Command Prompt on Windows.

Usage

Simply run setup_console::init() (or setup_console::try_init()) in the main function before printing anything.

fn main() {
    println!("\x1b[31mRed \x1b[32mGreen \x1b[34mBlue\x1b[39m");
    // ･[31mRed ･[32mGreen ･[34mBlue･[39m
    setup_console::init();
    println!("\x1b[31mRed \x1b[32mGreen \x1b[34mBlue\x1b[39m");
    // Red Green Blue
}

Panics

This only applies to Windows.

setup_console::init() doesn't panic, but shows message and terminates program with error code obtained from GetLastError() instead.

The situations that would lead program to terminate would be

when stdout is invalid (e.g. program 1>nul)
when program fails to run GetConsoleMode()
when program fails to run SetConsoleMode()

If this is not your desired behavior, you can use setup_console::try_init() which returns Result.

Adding setup_console library as a dependency

Adding `setup_console` library as a dependency