Crate color_please[][src]

Expand description

color_please

A simple library for coloring terminal and terminal text graphics control.
It uses ANSI control sequences for setting colors and effects, tested only on MacOS.
Some of the features in effect controls may not be supported in some systems or some terminal emulators.

Usage

Coloring Foreground and Background

use color_please::*;
fn main(){
    // Setting Foreground color and background color simply.
    set_fg(Color::Red);
    println!("This text is red.");
    set_bg(Color::Yellow);
    println!("And now the background is yellow.");
    // Bright Colors
    set_fg(Color::BrightGreen);
    println!("Why don't use bright green and look like a hacker in a film?");
    set_bg(Color::BrightCyan);
    println!("Walls of my terminal is my favourite color!");
    // Using 256 Colors
    set_fg(Color::Color256(123));
    println!("This text is color 123 of 256 colors.");
    // Using RGB
    set_bg(Color::ColorRGB(0, 200, 255));
    println!("The background is RGB(0,200,255).");
    // Reset the colors
    reset_fg();
    reset_bg();
}

Graphics Control

use color_please::*;
fn main(){
    // Making text effects on
    bold();
    faint();
    italic();
    underline();
    // To blinking
    blink();
    // Or not to blinking
    blink_off();
    // But this time faster
    fast_blink();
    // Ok, blinking sucks
    blink_off();
    // Reverse the foreground with background and make your eyes dazzle
    reverse();
    // Let's return to our black terminal, white theme sucks
    reverse_off();
    // Make texts invisible and surprise your friend
    invisible();
    println!("You can't see this.");
    // No need to close and open a new terminal
    invisible_off();
    println!("But you can see this.");
    // Strike the last item on your to do list
    strike();
    println!("Add color_please into the dependencies.");
    // Close striking
    strike_off();
    // Turn off the text effects
    bold_and_faint_off();
    underline_off();
    italic_off();
    // Or turn all of the effects and colors off at the same time
    reset_all();
}

LICENSE

This project is distributed under MIT license.

Enums

The enum includes the default 4-bit colors, bright colors, 256 colors and RGB colors.

Functions

Turns on the blink effect.

Turns the blink/rapid blink effect off.

Sets the terminal font bold.

Turns the bold and faint effects off.

Makes the faint effect, decreases the density of colors.

Turns on the rapid blink effect.

Makes the text invisible.

Makes the text appear if invisible.

Makes the terminal font italic.

Turns off italic font.

Makes the text given bold.

Returns the given text’s background dyed with the color given.

Returns the given text’s foreground dyed with color given.

Applies the faint effect on the text given.

Makes the text given invisible.

Makes the text given italic.

Switches the background and foreground colors of the text given.

Makes the text given striked.

Makes the text given underlined.

Resets all the graphical effects and colorings.

Resets the background color to default.

Resets the foreground color to default.

Switches the background color and the foreground color.

Turns the reverse effect off.

Sets the background color of the terminal.

Sets the foreground color of the terminal.

Strikes the text.

Turns off the strike effect.

Makes the text underlined.

Turns off the underlining.