Struct nu_ansi_term::Style [−][src]
pub struct Style {
pub foreground: Option<Color>,
pub background: Option<Color>,
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.
Examples
use nu_ansi_term::{Style, Color};
let style = Style::new().bold().on(Color::Black);
println!("{}", style.paint("Bold on black"));
Fields
foreground: Option<Color>
The style’s foreground color, if it has one.
background: Option<Color>
The style’s background color, 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 colors.
Whether this style is hidden.
is_strikethrough: bool
Whether this style is struckthrough.
Implementations
The prefix bytes for this style. These are the bytes that tell the terminal to use a different color or font style.
Examples
use nu_ansi_term::{Style, Color::Blue};
let style = Style::default().bold();
assert_eq!("\x1b[1m",
style.prefix().to_string());
let style = Blue.bold();
assert_eq!("\x1b[1;34m",
style.prefix().to_string());
let style = Style::default();
assert_eq!("",
style.prefix().to_string());
The infix bytes between this style and next
style. These are the bytes
that tell the terminal to change the style to next
. These may include
a reset followed by the next color and style, depending on the two styles.
Examples
use nu_ansi_term::{Style, Color::Green};
let style = Style::default().bold();
assert_eq!("\x1b[32m",
style.infix(Green.bold()).to_string());
let style = Green.normal();
assert_eq!("\x1b[1m",
style.infix(Green.bold()).to_string());
let style = Style::default();
assert_eq!("",
style.infix(style).to_string());
The suffix for this style. These are the bytes that tell the terminal to reset back to its normal color and font style.
Examples
use nu_ansi_term::{Style, Color::Green};
let style = Style::default().bold();
assert_eq!("\x1b[0m",
style.suffix().to_string());
let style = Green.normal().bold();
assert_eq!("\x1b[0m",
style.suffix().to_string());
let style = Style::default();
assert_eq!("",
style.suffix().to_string());
Creates a new Style with no properties set.
Examples
use nu_ansi_term::Style;
let style = Style::new();
println!("{}", style.paint("hi"));
Returns a Style
with the bold property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().bold();
println!("{}", style.paint("hey"));
Returns a Style
with the dimmed property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().dimmed();
println!("{}", style.paint("sup"));
Returns a Style
with the italic property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().italic();
println!("{}", style.paint("greetings"));
Returns a Style
with the underline property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().underline();
println!("{}", style.paint("salutations"));
Returns a Style
with the blink property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().blink();
println!("{}", style.paint("wazzup"));
Returns a Style
with the reverse property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().reverse();
println!("{}", style.paint("aloha"));
Returns a Style
with the hidden property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().hidden();
println!("{}", style.paint("ahoy"));
Returns a Style
with the strikethrough property set.
Examples
use nu_ansi_term::Style;
let style = Style::new().strikethrough();
println!("{}", style.paint("yo"));
Returns a Style
with the foreground color property set.
Examples
use nu_ansi_term::{Style, Color};
let style = Style::new().fg(Color::Yellow);
println!("{}", style.paint("hi"));
Returns a Style
with the background color property set.
Examples
use nu_ansi_term::{Style, Color};
let style = Style::new().on(Color::Blue);
println!("{}", style.paint("eyyyy"));
Trait Implementations
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 nu_ansi_term::Color::{Red, Blue};
assert_eq!("Style { fg(Red), on(Blue), bold, italic }",
format!("{:?}", Red.on(Blue).bold().italic()));
Returns a style with no properties set. Formatting text using this style returns the exact same text.
use nu_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());
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));
Auto Trait Implementations
impl RefUnwindSafe for Style
impl UnwindSafe for Style
Blanket Implementations
Mutably borrows from an owned value. Read more