(Rust) Coloring terminal so simple you already know how to do it !
(Rust) Coloring terminal so simple you already know how to do it !
Coloring terminal so simple, you already know how to do it!
…Add this in your Cargo.toml:
[dependencies]
colored = "3"and add this to your lib.rs or main.rs:
extern crate colored; // not needed in Rust 2018+
use colored::Colorize;
// test the example with `cargo run --example most_simple`
fn main() {
// TADAA!
println!("{} {} !", "it".green(), "works".blue().bold());
}CLICOLOR/CLICOLOR_FORCE behavior (see the specs)NO_COLOR behavior (see the specs)CLICOLOR_FORCE overrules NO_COLOR, which overrules CLICOLORBright colors: prepend the color by bright_. So easy.
Background colors: prepend the color by on_. Simple as that.
Bright Background colors: prepend the color by on_bright_. Not hard at all.
Colored has support for truecolors where you can specify any arbitrary rgb value.
This feature will only work correctly in terminals which support true colors (i.e. most modern terminals).
You can check if your terminal supports true color by checking the value of the environment variable $COLORTERM on your terminal. A value of truecolor or 24bit indicates that it will work.
You can clear color and style anytime by using normal() or clear()
As Color implements FromStr, From<&str>, and From<String>, you can easily cast a string into a color like that:
// the easy way
"blue string yo".color("blue");
// this will default to white
"white string".color("zorglub");
// the safer way via a Result
let color_res : Result<Color, ()> = "zorglub".parse();
"red string".color(color_res.unwrap_or(Color::Red));If you want to disable any coloring at compile time, you can simply do so by
using the no-color feature.
For example, you can do this in your Cargo.toml to disable color in tests:
[features]
# this effectively enable the feature `no-color` of colored when testing with
# `cargo test --features dumb_terminal`
dumb_terminal = ["colored/no-color"]You can have even finer control by using the
colored::control::set_override method.
This library wouldn't have been the same without the marvelous ruby gem colored.
Thanks for the ansi_term crate for providing a reference implementation, which greatly helped making this crate output correct strings.
The current MSRV is 1.80, which is checked and enforced automatically via CI. This version may change in the future in minor version bumps, so if you require a specific Rust version you should use a restricted version requirement such as ~X.Y.
Mozilla Public License 2.0. See the LICENSE file at the root of the repository.
In non legal terms it means that:
No open issues yet, or sync has not completed.