Struct OutputListBuilder

pub struct OutputListBuilder<'a> {
    pub output_list: Vec<Output<'a>>,
}

OutputListBuilder struct

Official Documentation,

Code Example

Using the OutputBuilder

use color_output::*;
OutputListBuilder::new_from(vec![Output::default()])
    .add(
        OutputBuilder::new()
            .text("text")
            .bg_color(ColorType::Use(Color::Blue))
            .endl(false)
            .build(),
    )
    .add(Output {
        text: "test_new_from_output_list_builder_1",
        color: ColorType::Use(Color::Default),
        bg_color: ColorType::Color256(0x3f3f3f),
        endl: false,
        ..Default::default()
    })
    .add(Output {
        text: "test_new_from_output_list_builder_2",
        color: ColorType::Use(Color::Default),
        bg_color: ColorType::Use(Color::Cyan),
        endl: true,
        ..Default::default()
    })
    .run();

Fields

output_list: Vec<Output<'a>>

A list of output structures.

Implementations

impl<'a> OutputListBuilder<'a>

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

Creates a new empty OutputListBuilder.

Returns

• Self: A new instance of OutputListBuilder with an empty output list.

pub fn new_from(output_list: Vec<Output<'a>>) -> OutputListBuilder<'a>

Creates a new OutputListBuilder from a given vector of outputs.

Parameters

• output_list: A vector of Output items to initialize the list with.

Returns

• Self: A new instance of OutputListBuilder containing the specified outputs.

pub fn add(&mut self, output: Output<'a>) -> &mut OutputListBuilder<'a>

Adds an output item to the output list.

Parameters

• &mut self: A mutable reference to the current instance of OutputListBuilder.
• output: The Output item to be added to the list.

Returns

• &mut Self: A mutable reference to the current instance, allowing for method chaining.

pub fn remove(&mut self, idx: usize) -> &mut OutputListBuilder<'a>

Removes an output item from the list at the specified index.

Parameters

• &mut self: A mutable reference to the current instance of OutputListBuilder.
• idx: The index of the output item to be removed.

Returns

• &mut Self: A mutable reference to the current instance, allowing for method chaining.

If the index is out of bounds, the list remains unchanged.

pub fn clear(&mut self)

Clears all output items from the output list.

Parameters

• &mut self: A mutable reference to the current instance of OutputListBuilder.

pub fn run(&mut self) -> &mut OutputListBuilder<'a>

Runs all output items in the list, executing their output logic.

Parameters

• &mut self: A mutable reference to the current instance of OutputListBuilder.

Returns

• &mut Self: A mutable reference to the current instance, allowing for method chaining.

The method clones the current output list, clears the original list, and executes the output for each cloned item.

pub fn query_idx(&self, idx: usize) -> Output<'_>

Queries the output item at the specified index.

Parameters

• &self: An immutable reference to the current instance of OutputListBuilder.
• idx: The index of the output item to query.

Returns

• Output: The output item at the specified index, or a default output if the index is out of bounds.

pub fn run_idx(&mut self, idx: usize) -> &mut OutputListBuilder<'a>

Runs the output item at the specified index.

Parameters

• &mut self: A mutable reference to the current instance of OutputListBuilder.
• idx: The index of the output item to run.

Returns

• &mut Self: A mutable reference to the current instance, allowing for method chaining.

If the index is out of bounds, the list remains unchanged.

Trait Implementations

impl<'a> Clone for OutputListBuilder<'a>

fn clone(&self) -> OutputListBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OutputListBuilder<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.