Struct termcolor::ColorSpec

source · [−]

pub struct ColorSpec { /* private fields */ }

Expand description

A color specification.

Implementations

source

impl ColorSpec

source

pub fn new() -> ColorSpec

Create a new color specification that has no colors or styles.

source

pub fn fg(&self) -> Option<&Color>

Get the foreground color.

source

pub fn set_fg(&mut self, color: Option<Color>) -> &mut ColorSpec

Set the foreground color.

source

pub fn bg(&self) -> Option<&Color>

Get the background color.

source

pub fn set_bg(&mut self, color: Option<Color>) -> &mut ColorSpec

Set the background color.

source

pub fn bold(&self) -> bool

Get whether this is bold or not.

Note that the bold setting has no effect in a Windows console.

source

pub fn set_bold(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is bolded or not.

Note that the bold setting has no effect in a Windows console.

source

pub fn dimmed(&self) -> bool

Get whether this is dimmed or not.

Note that the dimmed setting has no effect in a Windows console.

source

pub fn set_dimmed(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is dimmed or not.

Note that the dimmed setting has no effect in a Windows console.

source

pub fn italic(&self) -> bool

Get whether this is italic or not.

Note that the italic setting has no effect in a Windows console.

source

pub fn set_italic(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is italicized or not.

Note that the italic setting has no effect in a Windows console.

source

pub fn underline(&self) -> bool

Get whether this is underline or not.

Note that the underline setting has no effect in a Windows console.

source

pub fn set_underline(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is underlined or not.

Note that the underline setting has no effect in a Windows console.

source

pub fn strikethrough(&self) -> bool

Get whether this is strikethrough or not.

Note that the strikethrough setting has no effect in a Windows console.

source

pub fn set_strikethrough(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is strikethrough or not.

Note that the strikethrough setting has no effect in a Windows console.

source

pub fn reset(&self) -> bool

Get whether reset is enabled or not.

reset is enabled by default. When disabled and using ANSI escape sequences, a “reset” code will be emitted every time a ColorSpec’s settings are applied.

Note that the reset setting has no effect in a Windows console.

source

pub fn set_reset(&mut self, yes: bool) -> &mut ColorSpec

Set whether to reset the terminal whenever color settings are applied.

reset is enabled by default. When disabled and using ANSI escape sequences, a “reset” code will be emitted every time a ColorSpec’s settings are applied.

Typically this is useful if callers have a requirement to more scrupulously manage the exact sequence of escape codes that are emitted when using ANSI for colors.

Note that the reset setting has no effect in a Windows console.

source