Struct Table 

pub struct Table { /* private fields */ }

Main table type for terminal output.

A table owns its headers, rows, and column styling. Content is measured at render time, so the output can adapt to the current terminal width without manual layout code from the caller.

Typical Flow

1. Build the schema with Table::with_columns or Table::new.
2. Add rows with Table::add_row.
3. Adjust columns with Table::column if you need per-column overrides.
4. Call Table::render or print the table directly.

Example

use tiny_table::{Cell, Column, Align, Table, Trunc};

let mut table = Table::with_columns(vec![
    Column::new("Name").width(0.35),
    Column::new("Role").truncate(Trunc::Middle),
    Column::new("Status"),
]);

table.add_section("Team").align(Align::Center);
table.add_row(vec![
    Cell::new("Ada Lovelace"),
    Cell::new("Principal Engineer"),
    Cell::new("Active"),
]);

let rendered = table.render();
assert!(rendered.contains("Name"));
assert!(rendered.contains("Ada Lovelace"));

Implementations

impl Table

pub fn new() -> Self

Create an empty table using the default Unicode border style.

pub fn with_columns(columns: impl IntoIterator<Item = Column>) -> Self

Build a table from an explicit column schema.

Each Column contributes the header text and the default formatting for that column.

Examples found in repository

examples/simple.rs (lines 4-8)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").width(15),
        Column::new("Role").width(20),
        Column::new("Status").width(10),
    ]);

    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Engineer"),
        Cell::new("Active"),
    ]);

    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

examples/styled.rs (lines 4-8)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn with_style(self, style: TableStyle) -> Self

Replace the default border style for this table.

pub fn with_section_style(self, style: SectionStyle) -> Self

Set the default style used for all section rows added with Table::add_section.

Individual sections can still override this by calling .style() on the SectionBuilder returned by Table::add_section.

Examples found in repository

examples/styled.rs (lines 9-14)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn with_separator_style(self, style: SectionStyle) -> Self

Set the default style used for all separator rows added with Table::add_separator.

Individual separators can still override this by calling .style() on the SectionBuilder returned by Table::add_separator.

Examples found in repository

examples/styled.rs (lines 15-19)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn set_columns(&mut self, columns: impl IntoIterator<Item = Column>)

Replace the table schema with a new set of columns.

This clears existing headers and column-specific overrides before the new schema is applied.

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

Add a data row.

Short rows are padded with empty cells. If a row has more cells than the header list, the table expands to fit the additional columns.

Examples found in repository

examples/simple.rs (lines 10-14)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").width(15),
        Column::new("Role").width(20),
        Column::new("Status").width(10),
    ]);

    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Engineer"),
        Cell::new("Active"),
    ]);

    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

examples/styled.rs (lines 22-26)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn add_section(&mut self, title: impl ToString) -> SectionBuilder<'_>

Add a full-width section separator inside the table.

Section rows span the entire table width and are useful for grouping related data visually. The returned builder currently lets you choose the label alignment.

If a default section style was set with Table::with_section_style, it is applied automatically. Call .style() on the returned builder to override it.

Examples found in repository

examples/styled.rs (line 21)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn add_separator(&mut self) -> SectionBuilder<'_>

Add a full-width separator row with no label.

If a default separator style was set with Table::with_separator_style, it is applied automatically. Call .style() on the returned builder to override it.

Examples found in repository

examples/styled.rs (line 28)

fn main() {
    let mut table = Table::with_columns(vec![
        Column::new("Name").bright_cyan().bold().width(0.3),
        Column::new("Role").width(0.4).truncate(Trunc::Middle),
        Column::new("Status").bright_yellow().bold().width(0.3),
    ])
    .with_section_style(SectionStyle {
        horiz: "═",
        mid_left: "╞",
        mid_right: "╡",
        mid_joint: "╪",
    })
    .with_separator_style(SectionStyle {
        horiz: "╌",
        mid_joint: "│",
        ..SectionStyle::unicode()
    });

    table.add_section("Team").align(Align::Center);
    table.add_row(vec![
        Cell::new("Ada Lovelace"),
        Cell::new("Principal Engineer"),
        Cell::new("Active").bright_green(),
    ]);

    table.add_separator();
    table.add_row(vec![
        Cell::new("Bob"),
        Cell::new("Support"),
        Cell::new("Away"),
    ]);

    println!("{}", table);
}

pub fn column<T: Into<ColumnTarget>>(&mut self, target: T) -> ColumnBuilder<'_>

Configure a column using either its zero-based index or exact header text.

pub fn print(&self)

Print the formatted table to standard output.

pub fn render(&self) -> String

Render the formatted table as a single string.

The returned string includes ANSI color codes when styling is applied. Fractional widths are resolved using the current terminal size when it can be detected.

Trait Implementations

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Display for Table

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

Formats the value using the given formatter.