Struct Color

pub struct Color { /* private fields */ }

Color represents a color which can be set to things like Border, Padding and Margin.

Example

use tabled::{settings::Color, Table};

let data = [
    (0u8, "Hello"),
    (1u8, "World"),
];

let table = Table::new(data)
    .with(Color::BG_BLUE)
    .to_string();

println!("{}", table);

Implementations

impl Color

pub const FG_BLACK: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BLUE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_BLACK: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_BLUE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_CYAN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_GREEN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_MAGENTA: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_RED: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_WHITE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_BRIGHT_YELLOW: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_CYAN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_GREEN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_MAGENTA: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_RED: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_WHITE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const FG_YELLOW: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BLACK: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BLUE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_BLACK: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_BLUE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_CYAN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_GREEN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_MAGENTA: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_RED: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_WHITE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_BRIGHT_YELLOW: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_CYAN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_GREEN: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_MAGENTA: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_RED: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_WHITE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BG_YELLOW: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const BOLD: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

pub const UNDERLINE: Self

A color representation.

Notice that the colors are constants so you can’t combine them.

impl Color

pub fn new<P, S>(prefix: P, suffix: S) -> Self

where P: Into<String>, S: Into<String>,

Creates a new Color instance, with ANSI prefix and ANSI suffix. You can use [TryFrom] to construct it from [String`].

pub const fn empty() -> Self

Creates a new empty Color`.

pub fn get_prefix(&self) -> &str

Return a prefix.

pub fn get_suffix(&self) -> &str

Return a suffix.

pub fn as_ansi_str(&self) -> Option<StaticColor<'static>>

Tries to get a static value of the color.

pub fn rgb_fg(r: u8, g: u8, b: u8) -> Self

Create a 24 bit foreground color with RGB

pub fn rgb_bg(r: u8, g: u8, b: u8) -> Self

Create a 24 bit background color with RGB.

The terminal need to support the escape sequence

pub fn colorize<S>(&self, text: S) -> String

where S: AsRef<str>,

Colorize a string.

Trait Implementations

impl ANSIFmt for Color

fn fmt_ansi_prefix<W: Write>(&self, f: &mut W) -> Result

Print ANSI prefix.

fn fmt_ansi_suffix<W: Write>(&self, f: &mut W) -> Result

Print ANSI suffix.

impl BitOr for Color

type Output = Color

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<R> CellOption<R, ColoredConfig> for &Color

fn change(self, _: &mut R, cfg: &mut ColoredConfig, entity: Entity)

Modification function of a certail part of a grid targeted by Entity.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.

impl<R> CellOption<R, ColoredConfig> for Color

fn change(self, _: &mut R, cfg: &mut ColoredConfig, entity: Entity)

Modification function of a certail part of a grid targeted by Entity.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.

impl Clone for Color

fn clone(&self) -> Color

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

impl From<ANSIBuf> for Color

fn from(color: ANSIBuf) -> Self

Converts to this type from the input type.

impl From<ANSIStr<'static>> for Color

fn from(color: StaticColor<'static>) -> Self

Converts to this type from the input type.

impl From<Color> for ANSIBuf

fn from(color: Color) -> Self

Converts to this type from the input type.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Color

fn cmp(&self, other: &Color) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Color

fn eq(&self, other: &Color) -> 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 PartialOrd for Color

fn partial_cmp(&self, other: &Color) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R, D> TableOption<R, ColoredConfig, D> for Color

fn change(self, _: &mut R, cfg: &mut ColoredConfig, _: &mut D)

The function modificaties of records and a grid configuration.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.

impl Eq for Color

impl StructuralPartialEq for Color