Struct OutputBuilder

pub struct OutputBuilder<'a> {
    pub output: Output<'a>,
}

OutputBuilder struct

Official Documentation,

Code Example

Using the OutputBuilder

Using the output Function

use color_output::*;
output(
    OutputBuilder::new_from(Output::default())
        .text("test_output_builder")
        .color(ColorType::Color256(0xffffff))
        .bg_color(ColorType::Color256(0xffffff))
        .blod(true)
        .endl(true)
        .build(),
);

Using the output Method

use color_output::*;
OutputBuilder::new()
    .text("test_output_builder_output")
    .bg_color(ColorType::Color256(0xffffff))
    .color(ColorType::Color256(0xffffff))
    .blod(true)
    .endl(true)
    .build()
    .output();

Fields

output: Output<'a>

Implementations

impl<'a> OutputBuilder<'a>

pub fn new() -> OutputBuilder<'a>

Creates the struct

Returns

• OutputBuilder: Output

pub fn new_from(output: Output<'a>) -> OutputBuilder<'a>

Creates the struct from output

Returns

• OutputBuilder: Output

pub fn text(&mut self, text: &'a str) -> &mut OutputBuilder<'a>

Sets the text.

Parameters

• text: The text to be set.

Returns

• &mut Self: A mutable reference to the struct for method chaining.

pub fn color(&mut self, color: ColorType) -> &mut OutputBuilder<'a>

Sets the text color.

Parameters

• color: The color to be set for the text.

Returns

• &mut Self: A mutable reference to the struct for method chaining.

pub fn bg_color(&mut self, bg_color: ColorType) -> &mut OutputBuilder<'a>

Sets the background color for the text.

Parameters

• bg_color: The background color to be set for the text.

Returns

• &mut Self: A mutable reference to the struct for method chaining.

pub fn blod(&mut self, blod: bool) -> &mut OutputBuilder<'a>

Sets whether the text should be bold.

Parameters

• blod: A boolean indicating whether the text should be bold.

Returns

• &mut Self: A mutable reference to the struct for method chaining.

pub fn endl(&mut self, endl: bool) -> &mut OutputBuilder<'a>

Sets the endl value for the Output.

Parameters

• endl: A boolean value that determines whether to add a newline at the end.

Returns

• &mut Self: Returns a mutable reference to the current Output instance, allowing method chaining.

pub fn build(&self) -> Output<'_>

Builds and returns the Output struct.

Returns

• Output: The constructed Output struct.

pub fn output(&self)

Outputs the current state of the Output struct.

Returns

• () : Nothing is returned.