Enum ansi_term::Colour

pub enum Colour {
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Purple,
    Cyan,
    White,
    Fixed(u8),
    RGB(u8, u8, u8),
}

[−] Expand description

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

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

Variants

Black

[−] Expand description

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

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

Red

[−] Expand description

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

Green

[−] Expand description

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

Yellow

[−] Expand description

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

Blue

[−] Expand description

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

Purple

[−] Expand description

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

Cyan

[−] Expand description

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

White

[−] Expand description

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

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

Fixed(u8)

[−] Expand description

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

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

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

RGB(u8, u8, u8)

[−] Expand description

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

Methods

impl Colour

pub fn prefix(self) -> Prefix[−]

The prefix for this colour.

pub fn infix(self, other: Colour) -> Infix[−]

The infix between this colour and another.

pub fn suffix(self) -> Suffix[−]

The suffix for this colour.

impl Colour

pub fn normal(self) -> Style[−]

Return a Style with the foreground colour set to this colour.

pub fn bold(self) -> Style[−]

Returns a Style with the bold property set.

pub fn dimmed(self) -> Style[−]

Returns a Style with the dimmed property set.

pub fn italic(self) -> Style[−]

Returns a Style with the italic property set.

pub fn underline(self) -> Style[−]

Returns a Style with the underline property set.

pub fn blink(self) -> Style[−]

Returns a Style with the blink property set.

pub fn reverse(self) -> Style[−]

Returns a Style with the reverse property set.

pub fn hidden(self) -> Style[−]

Returns a Style with the hidden property set.

pub fn strikethrough(self) -> Style[−]

Returns a Style with the strikethrough property set.

pub fn on(self, background: Colour) -> Style[−]

Returns a Style with the background colour property set.

impl Colour

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 colour, returning an ANSI string. This is a short-cut so you don’t have to use Blue.normal() just to get blue text.

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

Trait Implementations

impl PartialEq for Colour

fn eq(&self, __arg_0: &Colour) -> bool[−]

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

fn ne(&self, __arg_0: &Colour) -> bool[−]

This method tests for !=.

impl Clone for Colour

fn clone(&self) -> Colour[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Colour

impl Debug for Colour

fn fmt(&self, __arg_0: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl From<Colour> for Style

fn from(colour: Colour) -> Style[−]

You can turn a Colour into a Style with the foreground colour set with the From trait.

use ansi_term::{Style, Colour};
let green_foreground = Style::default().fg(Colour::Green);
assert_eq!(green_foreground, Colour::Green.normal());
assert_eq!(green_foreground, Colour::Green.into());
assert_eq!(green_foreground, Style::from(Colour::Green));