Struct colored_json::Style
source · pub struct Style {
pub foreground: Option<Colour>,
pub background: Option<Colour>,
pub is_bold: bool,
pub is_dimmed: bool,
pub is_italic: bool,
pub is_underline: bool,
pub is_blink: bool,
pub is_reverse: bool,
pub is_hidden: bool,
pub is_strikethrough: bool,
}
Expand description
A style is a collection of properties that can format a string using ANSI escape codes.
Fields
foreground: Option<Colour>
The style’s foreground colour, if it has one.
background: Option<Colour>
The style’s background colour, if it has one.
is_bold: bool
Whether this style is bold.
is_dimmed: bool
Whether this style is dimmed.
is_italic: bool
Whether this style is italic.
is_underline: bool
Whether this style is underlined.
is_blink: bool
Whether this style is blinking.
is_reverse: bool
Whether this style has reverse colours.
Whether this style is hidden.
is_strikethrough: bool
Whether this style is struckthrough.
Implementations
sourceimpl Style
impl Style
Returns a Style
with the hidden property set.
sourcepub fn strikethrough(&self) -> Style
pub fn strikethrough(&self) -> Style
Returns a Style
with the hidden property set.
sourcepub fn fg(&self, foreground: Colour) -> Style
pub fn fg(&self, foreground: Colour) -> Style
Returns a Style
with the foreground colour property set.
Trait Implementations
sourceimpl Debug for Style
impl Debug for Style
Styles have a special Debug
implementation that only shows the fields that
are set. Fields that haven’t been touched aren’t included in the output.
This behaviour gets bypassed when using the alternate formatting mode
format!("{:#?}")
.
use ansi_term::Colour::{Red, Blue};
assert_eq!("Style { fg(Red), on(Blue), bold, italic }",
format!("{:?}", Red.on(Blue).bold().italic()));
sourceimpl Default for Style
impl Default for Style
sourcefn default() -> Style
fn default() -> Style
Returns a style with no properties set. Formatting text using this style returns the exact same text.
use ansi_term::Style;
assert_eq!(None, Style::default().foreground);
assert_eq!(None, Style::default().background);
assert_eq!(false, Style::default().is_bold);
assert_eq!("txt", Style::default().paint("txt").to_string());
sourceimpl From<Colour> for Style
impl From<Colour> for Style
sourcefn from(colour: Colour) -> 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));