Struct Style

Source

pub struct Style { /* private fields */ }

Expand description

A collection of properties that can be used to format a string using ANSI escape codes.

Implementations§

Source §

impl Style

Source

pub fn new() -> Self

Creates a new Style struct

Source

pub fn builder() -> StyleBuilder

Creates a new StyleBuilder struct

Examples found in repository ?

examples/console.rs (line 16)

3fn main() {
4    // You can either color the text directly with the Color enumeration
5    println!(
6        "{}Cyan colored \"Hello World!\"{}",
7        Color::Cyan.open(),
8        Color::Cyan.close()
9    );
10
11    // or you can use the builder function from within the Style stuct
12    // to create a style that can be used for more than one instance of
13    // a string and you wouldn't need to have an open and close function
14    // prepended and appended to every text you type like the above example
15
16    let style = Style::builder().red().strikethrough().build();
17
18    println!("{}", style.stylize("Hello World in red with strikethrough"));
19
20    println!("This is in red: {}", Color::Red.paint("a red string"));
21}

Source

pub fn bold(&self) -> bool

Checks whether or not the text’s style is bold

Source

pub fn dim(&self) -> bool

Checks whether or not the text’s style is dim

Source

pub fn italic(&self) -> bool

Checks whether or not the text’s style is italic

Source

pub fn underline(&self) -> bool

Checks whether or not the text’s style is underline

Source

pub fn blink(&self) -> bool

Checks whether or not the text’s style is blink

Source

pub fn inverse(&self) -> bool

Checks whether or not the text’s style is inverse

Source

pub fn hidden(&self) -> bool

Checks whether or not the text’s style is hidden

Source

pub fn strikethrough(&self) -> bool

Checks whether or not the text’s style is strikethrough

Source

pub fn overline(&self) -> bool

Checks whether or not the text’s style is overline

Source

pub fn color(&self) -> Color

Checks whether oor not the current style has a text color if no color is provided a default color Color::Any will be provided

Source

pub fn bg_color(&self) -> BGColor

Checks whether oor not the current style has a text background color if no color is provided a default color BGColor::Any will be provided

Source

pub fn rgb_to_ansi256(red: u8, green: u8, blue: u8) -> u8

Converts three values (red, green, blue) to an ansi 256-color lookup (8-bit)

§Arguments

red - a number representation for red
green - a number representation for green
blue - a number representation for blue

Source

pub fn stylize(&self, text: &str) -> String

Adds style to a given text

text - the string of characters to add style to

Examples found in repository ?

examples/console.rs (line 18)

3fn main() {
4    // You can either color the text directly with the Color enumeration
5    println!(
6        "{}Cyan colored \"Hello World!\"{}",
7        Color::Cyan.open(),
8        Color::Cyan.close()
9    );
10
11    // or you can use the builder function from within the Style stuct
12    // to create a style that can be used for more than one instance of
13    // a string and you wouldn't need to have an open and close function
14    // prepended and appended to every text you type like the above example
15
16    let style = Style::builder().red().strikethrough().build();
17
18    println!("{}", style.stylize("Hello World in red with strikethrough"));
19
20    println!("This is in red: {}", Color::Red.paint("a red string"));
21}