Struct Formatting 

pub struct Formatting {
    pub foreground_color: Option<Color>,
    pub background_color: Option<Color>,
    pub text_formatting: Vec<FormattingOption>,
}

Represent the text formatting which includes

• Color of the text
• Color of the background
• Text formatting options

Fields

foreground_color: Option<Color>

Text color

background_color: Option<Color>

Background color

text_formatting: Vec<FormattingOption>

List of formatting options

Implementations

impl Formatting

pub fn foreground_color(self, color: Color) -> Self

Set the text color

Examples found in repository

examples/styling.rs (line 20)

fn main() -> Result<()> {
    let label_style = LabelStyle::default()
        .prefix("*")
        .prefix_formatting(Formatting::default().foreground_color(Color::Cyan))
        .prompt_formatting(
            Formatting::default()
                .bold()
                .underline()
                .foreground_color(Color::Magenta),
        );
    let input_formatting = Formatting::default().foreground_color(Color::Cyan);
    let submitted_formatting = Formatting::default().foreground_color(Color::DarkCyan);

    let name = Input::new("Enter your name", name_validation)
        .style(
            InputStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();
    let coffee = Confirmation::new("Do you want a cup of coffee")
        .style(
            ConfirmationStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();

    println!("Name: {:?}", name);
    println!("Coffee: {:?}", coffee);

    Ok(())
}

pub fn background_color(self, color: Color) -> Self

Set the background color

pub fn bold(self) -> Self

Make the text bold

Examples found in repository

examples/styling.rs (line 23)

fn main() -> Result<()> {
    let label_style = LabelStyle::default()
        .prefix("*")
        .prefix_formatting(Formatting::default().foreground_color(Color::Cyan))
        .prompt_formatting(
            Formatting::default()
                .bold()
                .underline()
                .foreground_color(Color::Magenta),
        );
    let input_formatting = Formatting::default().foreground_color(Color::Cyan);
    let submitted_formatting = Formatting::default().foreground_color(Color::DarkCyan);

    let name = Input::new("Enter your name", name_validation)
        .style(
            InputStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();
    let coffee = Confirmation::new("Do you want a cup of coffee")
        .style(
            ConfirmationStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();

    println!("Name: {:?}", name);
    println!("Coffee: {:?}", coffee);

    Ok(())
}

pub fn italic(self) -> Self

Make the text italic

pub fn underline(self) -> Self

Underline the text

Examples found in repository

examples/styling.rs (line 24)

fn main() -> Result<()> {
    let label_style = LabelStyle::default()
        .prefix("*")
        .prefix_formatting(Formatting::default().foreground_color(Color::Cyan))
        .prompt_formatting(
            Formatting::default()
                .bold()
                .underline()
                .foreground_color(Color::Magenta),
        );
    let input_formatting = Formatting::default().foreground_color(Color::Cyan);
    let submitted_formatting = Formatting::default().foreground_color(Color::DarkCyan);

    let name = Input::new("Enter your name", name_validation)
        .style(
            InputStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();
    let coffee = Confirmation::new("Do you want a cup of coffee")
        .style(
            ConfirmationStyle::default()
                .label_style(label_style.clone())
                .input_formatting(input_formatting.clone())
                .submitted_formatting(submitted_formatting.clone()),
        )
        .display();

    println!("Name: {:?}", name);
    println!("Coffee: {:?}", coffee);

    Ok(())
}

pub fn crossed_out(self) -> Self

Cross the text out

pub fn reset() -> Self

Reset text formatting (colors and options)

pub fn print( &self, text: impl Into<String>, cmd_buffer: &mut impl CommandBuffer, )

Print the given text using the current formatting to the provided command buffer

Trait Implementations

impl Clone for Formatting

fn clone(&self) -> Formatting

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Formatting

fn default() -> Self

Returns the “default value” for a type.