Enum ColorSpec 

pub enum ColorSpec {
    Reset,
    PaletteIndex(PaletteIndex),
    TrueColor(RgbaColor),
}

Terminal color specification for Sgr color commands.

This is the common color input type for foreground, background, and underline colors. Named ANSI colors and 256-color palette values use Self::PaletteIndex; true-color values use Self::TrueColor; Self::Reset returns the terminal color to its default.

use termina::{
    escape::csi::{Csi, Sgr},
    style::{ColorSpec, RgbColor},
};

assert_eq!(Csi::Sgr(Sgr::Foreground(ColorSpec::RED)).to_string(), "\x1b[31m");

let blue = ColorSpec::from(RgbColor::new(0, 0, 255));
assert_eq!(Csi::Sgr(Sgr::Foreground(blue)).to_string(), "\x1b[38;2;0;0;255m");

Variants

Reset

Reset the color back to the terminal default.

For SGR foreground and background colors this formats as the standard reset color codes rather than as an indexed palette color.

PaletteIndex(PaletteIndex)

Use an indexed palette color.

Values 0-15 address the standard ANSI palette. Values 16-255 address the 256-color extension palette described by WebColor.

TrueColor(RgbaColor)

Use a true-color red, green, blue, and alpha value.

Red, green, and blue values format using SGR true-color parameters. Non-opaque alpha uses the colon form from ITU T.416-style color notation.

Implementations

impl ColorSpec

pub const BLACK: Self

Standard black palette color.

pub const RED: Self

Standard red palette color.

pub const GREEN: Self

Standard green palette color.

pub const YELLOW: Self

Standard yellow palette color.

pub const BLUE: Self

Standard blue palette color.

pub const MAGENTA: Self

Standard magenta palette color.

pub const CYAN: Self

Standard cyan palette color.

pub const WHITE: Self

Standard white palette color.

pub const BRIGHT_BLACK: Self

Bright black palette color.

pub const BRIGHT_RED: Self

Bright red palette color.

pub const BRIGHT_GREEN: Self

Bright green palette color.

pub const BRIGHT_YELLOW: Self

Bright yellow palette color.

pub const BRIGHT_BLUE: Self

Bright blue palette color.

pub const BRIGHT_MAGENTA: Self

Bright magenta palette color.

pub const BRIGHT_CYAN: Self

Bright cyan palette color.

pub const BRIGHT_WHITE: Self

Bright white palette color.

Trait Implementations

impl Clone for ColorSpec

fn clone(&self) -> ColorSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColorSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<AnsiColor> for ColorSpec

fn from(color: AnsiColor) -> Self

Converts to this type from the input type.

impl From<RgbColor> for ColorSpec

fn from(color: RgbColor) -> Self

Converts to this type from the input type.

impl From<RgbaColor> for ColorSpec

fn from(color: RgbaColor) -> Self

Converts to this type from the input type.

impl From<WebColor> for ColorSpec

fn from(color: WebColor) -> Self

Converts to this type from the input type.

impl PartialEq for ColorSpec

fn eq(&self, other: &ColorSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ColorSpec

impl Eq for ColorSpec

impl StructuralPartialEq for ColorSpec