Struct Table 

pub struct Table { /* private fields */ }

A simple table builder for rendering tabular CLI output.

Examples

use blazer::table::Table;

let mut table = Table::new(vec!["Name", "Age", "City"]);
table.add_row(vec!["Alice", "30", "NYC"]);
table.add_row(vec!["Bob", "25", "LA"]);
println!("{}", table.render());

Implementations

impl Table

pub fn new(headers: Vec<&str>) -> Self

Creates a new table with the given column headers.

Examples found in repository

examples/table_demo.rs (line 4)

fn main() {
    let mut table = Table::new(vec!["Task", "Status", "Duration"])
        .with_borders(Borders::EMPTY)
        .with_alignment(Alignment::Center);
    table.add_row(vec!["build", "ok", "4.2s"]);
    table.add_row(vec!["test", "failed", "12.9s"]);
    table.add_row(vec!["lint", "ok", "1.1s"]);


    table.print();
}

pub fn with_alignment(self, alignment: Alignment) -> Self

Sets the alignment used for all cells.

Examples found in repository

examples/table_demo.rs (line 6)

fn main() {
    let mut table = Table::new(vec!["Task", "Status", "Duration"])
        .with_borders(Borders::EMPTY)
        .with_alignment(Alignment::Center);
    table.add_row(vec!["build", "ok", "4.2s"]);
    table.add_row(vec!["test", "failed", "12.9s"]);
    table.add_row(vec!["lint", "ok", "1.1s"]);


    table.print();
}

pub fn with_borders(self, borders: Borders) -> Self

Sets the border characters used for the table.

Examples found in repository

examples/table_demo.rs (line 5)

fn main() {
    let mut table = Table::new(vec!["Task", "Status", "Duration"])
        .with_borders(Borders::EMPTY)
        .with_alignment(Alignment::Center);
    table.add_row(vec!["build", "ok", "4.2s"]);
    table.add_row(vec!["test", "failed", "12.9s"]);
    table.add_row(vec!["lint", "ok", "1.1s"]);


    table.print();
}

pub fn borderless(self) -> Self

Disables all borders.

pub fn with_padding(self, padding: Padding) -> Self

Sets the padding used for all cells.

pub fn add_row(&mut self, row: Vec<&str>)

Adds a row of data to the table.

Rows with fewer cells than there are headers will have missing cells rendered as empty strings.

Examples found in repository

examples/table_demo.rs (line 7)

fn main() {
    let mut table = Table::new(vec!["Task", "Status", "Duration"])
        .with_borders(Borders::EMPTY)
        .with_alignment(Alignment::Center);
    table.add_row(vec!["build", "ok", "4.2s"]);
    table.add_row(vec!["test", "failed", "12.9s"]);
    table.add_row(vec!["lint", "ok", "1.1s"]);


    table.print();
}

pub fn render(&self) -> String

Renders the table as a formatted, box-drawn string ready to print.

pub fn print(&self)

Renders and prints the table directly to stdout.

Examples found in repository

examples/table_demo.rs (line 12)

fn main() {
    let mut table = Table::new(vec!["Task", "Status", "Duration"])
        .with_borders(Borders::EMPTY)
        .with_alignment(Alignment::Center);
    table.add_row(vec!["build", "ok", "4.2s"]);
    table.add_row(vec!["test", "failed", "12.9s"]);
    table.add_row(vec!["lint", "ok", "1.1s"]);


    table.print();
}

Trait Implementations

impl Display for Table

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

Formats the value using the given formatter.