Struct StyleBuilder 

pub struct StyleBuilder { /* private fields */ }

A helper struct for creating the Style object

Implementations

impl StyleBuilder

pub fn new() -> Self

Creates a new StyleBuilder struct for creating styles

pub fn bold(self) -> Self

Sets the bold property to true

pub fn dim(self) -> Self

Sets the dim property to true

pub fn italic(self) -> Self

Sets the italic property to true

pub fn underline(self) -> Self

Sets the underline property to true

pub fn blink(self) -> Self

Sets the blink property to true

pub fn inverse(self) -> Self

Sets the inverse property to true

pub fn hidden(self) -> Self

Sets the hidden property to true

pub fn strikethrough(self) -> Self

Sets the strikethrough property to true

Examples found in repository

examples/console.rs (line 16)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

pub fn overline(self) -> Self

Sets the overline property to true

pub fn black(self) -> Self

Sets the text color to black

pub fn red(self) -> Self

Sets the text color to red

Examples found in repository

examples/console.rs (line 16)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

pub fn green(self) -> Self

Sets the text color to green

pub fn yellow(self) -> Self

Sets the text color to yellow

pub fn blue(self) -> Self

Sets the text color to blue

pub fn magenta(self) -> Self

Sets the text color to magenta

pub fn cyan(self) -> Self

Sets the text color to cyan

pub fn white(self) -> Self

Sets the text color to white

pub fn black_bright(self) -> Self

Sets the text color to a bright black (gray)

pub fn red_bright(self) -> Self

Sets the text color to a bright red

pub fn green_bright(self) -> Self

Sets the text color to a bright green

pub fn yellow_bright(self) -> Self

Sets the text color to a bright yellow

pub fn blue_bright(self) -> Self

Sets the text color to a bright blue

pub fn magenta_bright(self) -> Self

Sets the text color to a bright magenta

pub fn cyan_bright(self) -> Self

Sets the text color to a bright cyan

pub fn white_bright(self) -> Self

Sets the text color to a bright white

pub fn bg_black(self) -> Self

Sets the text’s bckground color to black

pub fn bg_red(self) -> Self

Sets the text’s bckground color to red

pub fn bg_green(self) -> Self

Sets the text’s bckground color to green

pub fn bg_yellow(self) -> Self

Sets the text’s bckground color to yellow

pub fn bg_blue(self) -> Self

Sets the text’s bckground color to blue

pub fn bg_magenta(self) -> Self

Sets the text’s bckground color to magenta

pub fn bg_cyan(self) -> Self

Sets the text’s bckground color to cyan

pub fn bg_white(self) -> Self

Sets the text’s bckground color to white

pub fn bg_black_bright(self) -> Self

Sets the text’s bckground color to a bright black (gray)

pub fn bg_red_bright(self) -> Self

Sets the text’s bckground color to a bright red

pub fn bg_green_bright(self) -> Self

Sets the text’s bckground color to a bright green

pub fn bg_yellow_bright(self) -> Self

Sets the text’s bckground color to a bright yellow

pub fn bg_blue_bright(self) -> Self

Sets the text’s bckground color to a bright blue

pub fn bg_magenta_bright(self) -> Self

Sets the text’s bckground color to a bright magenta

pub fn bg_cyan_bright(self) -> Self

Sets the text’s bckground color to a bright cyan

pub fn bg_white_bright(self) -> Self

Sets the text’s bckground color to a bright white

pub fn build(self) -> Style

Builds a Style struct from a the current instance of the StyleBuilder struct

Examples found in repository

examples/console.rs (line 16)

fn main() {
    // You can either color the text directly with the Color enumeration
    println!(
        "{}Cyan colored \"Hello World!\"{}",
        Color::Cyan.open(),
        Color::Cyan.close()
    );

    // or you can use the builder function from within the Style stuct
    // to create a style that can be used for more than one instance of
    // a string and you wouldn't need to have an open and close function
    // prepended and appended to every text you type like the above example

    let style = Style::builder().red().strikethrough().build();

    println!("{}", style.stylize("Hello World in red with strikethrough"));

    println!("This is in red: {}", Color::Red.paint("a red string"));
}

Trait Implementations

impl Default for StyleBuilder

fn default() -> Self

Returns the “default value” for a type.