Enum nu_ansi_term::Color

source ·
pub enum Color {
Show 21 variants Black, DarkGray, Red, LightRed, Green, LightGreen, Yellow, LightYellow, Blue, LightBlue, Purple, LightPurple, Magenta, LightMagenta, Cyan, LightCyan, White, LightGray, Fixed(u8), Rgb(u8, u8, u8), Default,
}
Expand description

A color is one specific type of ANSI escape code, and can refer to either the foreground or background color.

These use the standard numeric sequences. See http://invisible-island.net/xterm/ctlseqs/ctlseqs.html

Variants§

§

Black

Color #0 (foreground code 30, background code 40).

This is not necessarily the background color, and using it as one may render the text hard to read on terminals with dark backgrounds.

§

DarkGray

Color #0 (foreground code 90, background code 100).

§

Red

Color #1 (foreground code 31, background code 41).

§

LightRed

Color #1 (foreground code 91, background code 101).

§

Green

Color #2 (foreground code 32, background code 42).

§

LightGreen

Color #2 (foreground code 92, background code 102).

§

Yellow

Color #3 (foreground code 33, background code 43).

§

LightYellow

Color #3 (foreground code 93, background code 103).

§

Blue

Color #4 (foreground code 34, background code 44).

§

LightBlue

Color #4 (foreground code 94, background code 104).

§

Purple

Color #5 (foreground code 35, background code 45).

§

LightPurple

Color #5 (foreground code 95, background code 105).

§

Magenta

Color #5 (foreground code 35, background code 45).

§

LightMagenta

Color #5 (foreground code 95, background code 105).

§

Cyan

Color #6 (foreground code 36, background code 46).

§

LightCyan

Color #6 (foreground code 96, background code 106).

§

White

Color #7 (foreground code 37, background code 47).

As above, this is not necessarily the foreground color, and may be hard to read on terminals with light backgrounds.

§

LightGray

Color #7 (foreground code 97, background code 107).

§

Fixed(u8)

A color number from 0 to 255, for use in 256-color terminal environments.

  • colors 0 to 7 are the Black to White variants respectively. These colors can usually be changed in the terminal emulator.
  • colors 8 to 15 are brighter versions of the eight colors above. These can also usually be changed in the terminal emulator, or it could be configured to use the original colors and show the text in bold instead. It varies depending on the program.
  • colors 16 to 231 contain several palettes of bright colors, arranged in six squares measuring six by six each.
  • colors 232 to 255 are shades of grey from black to white.

It might make more sense to look at a color chart.

§

Rgb(u8, u8, u8)

A 24-bit Rgb color, as specified by ISO-8613-3.

§

Default

The default color (foreground code 39, background codr 49).

Implementations§

source§

impl Color

source

pub fn prefix(self) -> Prefix

The prefix bytes for this color as a Style. These are the bytes that tell the terminal to use a different color or font style.

See also Style::prefix.

§Examples
use nu_ansi_term::Color::Green;

assert_eq!("\x1b[32m",
           Green.prefix().to_string());
source

pub fn infix(self, next: Color) -> Infix

The infix bytes between this color and next color. These are the bytes that tell the terminal to use the next color, or to do nothing if the two colors are equal.

See also Style::infix.

§Examples
use nu_ansi_term::Color::{Red, Yellow};

assert_eq!("\x1b[33m",
           Red.infix(Yellow).to_string());
source

pub fn suffix(self) -> Suffix

The suffix for this color as a Style. These are the bytes that tell the terminal to reset back to its normal color and font style.

See also Style::suffix.

§Examples
use nu_ansi_term::Color::Purple;

assert_eq!("\x1b[0m",
           Purple.suffix().to_string());
source§

impl Color

source

pub fn normal(self) -> Style

Returns a Style with the foreground color set to this color.

§Examples
use nu_ansi_term::Color;

let style = Color::Red.normal();
println!("{}", style.paint("hi"));
source

pub fn bold(self) -> Style

Returns a Style with the foreground color set to this color and the bold property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Green.bold();
println!("{}", style.paint("hey"));
source

pub fn dimmed(self) -> Style

Returns a Style with the foreground color set to this color and the dimmed property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Yellow.dimmed();
println!("{}", style.paint("sup"));
source

pub fn italic(self) -> Style

Returns a Style with the foreground color set to this color and the italic property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Blue.italic();
println!("{}", style.paint("greetings"));
source

pub fn underline(self) -> Style

Returns a Style with the foreground color set to this color and the underline property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Purple.underline();
println!("{}", style.paint("salutations"));

Returns a Style with the foreground color set to this color and the blink property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Cyan.blink();
println!("{}", style.paint("wazzup"));
source

pub fn reverse(self) -> Style

Returns a Style with the foreground color set to this color and the reverse property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Black.reverse();
println!("{}", style.paint("aloha"));
source

pub fn hidden(self) -> Style

Returns a Style with the foreground color set to this color and the hidden property set.

§Examples
use nu_ansi_term::Color;

let style = Color::White.hidden();
println!("{}", style.paint("ahoy"));
source

pub fn strikethrough(self) -> Style

Returns a Style with the foreground color set to this color and the strikethrough property set.

§Examples
use nu_ansi_term::Color;

let style = Color::Fixed(244).strikethrough();
println!("{}", style.paint("yo"));
source

pub fn reset_before_style(self) -> Style

Returns a Style thats resets all styling before applying the foreground color set to this color.

§Examples
use nu_ansi_term::Color;

let style = Color::Fixed(244).reset_before_style();
println!("{}", style.paint("yo"));
source

pub fn on(self, background: Color) -> Style

Returns a Style with the foreground color set to this color and the background color property set to the given color.

§Examples
use nu_ansi_term::Color;

let style = Color::Rgb(31, 31, 31).on(Color::White);
println!("{}", style.paint("eyyyy"));
source§

impl Color

source

pub fn paint<'a, I, S: 'a + ToOwned + ?Sized>( self, input: I, ) -> AnsiGenericString<'a, S>
where I: Into<Cow<'a, S>>, <S as ToOwned>::Owned: Debug,

Paints the given text with this color, returning an ANSI string. This is a short-cut so you don’t have to use Blue.normal() just to get blue text.

use nu_ansi_term::Color::Blue;
println!("{}", Blue.paint("da ba dee"));

Trait Implementations§

source§

impl Clone for Color

source§

fn clone(&self) -> Color

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Color

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Color

source§

fn default() -> Color

Returns the “default value” for a type. Read more
source§

impl From<Color> for Style

source§

fn from(color: Color) -> Style

You can turn a Color into a Style with the foreground color set with the From trait.

use nu_ansi_term::{Style, Color};
let green_foreground = Style::default().fg(Color::Green);
assert_eq!(green_foreground, Color::Green.normal());
assert_eq!(green_foreground, Color::Green.into());
assert_eq!(green_foreground, Style::from(Color::Green));
source§

impl PartialEq for Color

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Color

source§

impl Eq for Color

source§

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnwindSafe for Color

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.