Struct crossterm_style::TerminalColor

pub struct TerminalColor { /* fields omitted */ }

A terminal color.

Examples

Basic usage:

// You can replace the following line with `use crossterm::TerminalColor;`
// if you're using the `crossterm` crate with the `style` feature enabled.
use crossterm_style::{Result, TerminalColor, Color};

fn main() -> Result<()> {
    let color = TerminalColor::new();
    // Set foreground color
    color.set_fg(Color::Blue)?;
    // Set background color
    color.set_bg(Color::Red)?;
    // Reset to the default colors
    color.reset()
}

Methods

impl TerminalColor

pub fn new() -> TerminalColor

Creates a new TerminalColor.

pub fn set_fg(&self, color: Color) -> Result<()>

Sets the foreground color.

pub fn set_bg(&self, color: Color) -> Result<()>

Sets the background color.

pub fn reset(&self) -> Result<()>

Resets the terminal colors and attributes to the default ones.

pub fn available_color_count(&self) -> u16

Returns available color count.

Notes

This does not always provide a good result.