Struct Column 

pub struct Column { /* private fields */ }

A column definition that bundles the header text with default styling.

Use this when you already know your schema and want the table to inherit width, truncation, and color defaults from the column definition.

Examples

use tiny_table::{Column, Color, Trunc};

let column = Column::new("Status")
    .color(Color::BrightGreen)
    .width(12)
    .truncate(Trunc::End);

Implementations

impl Column

pub fn new(header: impl Into<Cell>) -> Self

Create a new column definition from a header value.

Examples found in repository

examples/simple.rs (line 5)

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 (line 5)

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 width(self, width: impl Into<ColumnWidth>) -> Self

Set the preferred width for this column.

Examples found in repository

examples/simple.rs (line 5)

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 (line 5)

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 max_width(self, width: impl Into<ColumnWidth>) -> Self

Alias for Column::width.

pub fn truncate(self, truncation: Trunc) -> Self

Set the default truncation strategy used by this column.

Examples found in repository

examples/styled.rs (line 6)

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 align(self, align: Align) -> Self

Set the default text alignment for this column.

impl Column

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

Apply a foreground color.

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

Apply a background color.

pub fn clear(self) -> Self

Clear all formatting.

pub fn normal(self) -> Self

Reset formatting back to normal.

pub fn bold(self) -> Self

Make the text bold.

Examples found in repository

examples/styled.rs (line 5)

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 dimmed(self) -> Self

Make the text dimmed.

pub fn italic(self) -> Self

Make the text italic.

pub fn underline(self) -> Self

Underline the text.

pub fn blink(self) -> Self

Blink the text.

pub fn reversed(self) -> Self

Reverse foreground and background colors.

pub fn hidden(self) -> Self

Hide the text.

pub fn strikethrough(self) -> Self

Strike the text through.

pub fn black(self) -> Self

Use a black foreground color.

pub fn red(self) -> Self

Use a red foreground color.

pub fn green(self) -> Self

Use a green foreground color.

pub fn yellow(self) -> Self

Use a yellow foreground color.

pub fn blue(self) -> Self

Use a blue foreground color.

pub fn magenta(self) -> Self

Use a magenta foreground color.

pub fn cyan(self) -> Self

Use a cyan foreground color.

pub fn white(self) -> Self

Use a white foreground color.

pub fn bright_black(self) -> Self

Use a bright black foreground color.

pub fn bright_red(self) -> Self

Use a bright red foreground color.

pub fn bright_green(self) -> Self

Use a bright green foreground color.

pub fn bright_yellow(self) -> Self

Use a bright yellow foreground color.

Examples found in repository

examples/styled.rs (line 7)

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 bright_blue(self) -> Self

Use a bright blue foreground color.

pub fn bright_magenta(self) -> Self

Use a bright magenta foreground color.

pub fn bright_cyan(self) -> Self

Use a bright cyan foreground color.

Examples found in repository

examples/styled.rs (line 5)

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 bright_white(self) -> Self

Use a bright white foreground color.

pub fn purple(self) -> Self

Use a purple foreground color.

pub fn bright_purple(self) -> Self

Use a bright purple foreground color.

pub fn ansi_color(self, color: impl Into<u8>) -> Self

Use an ANSI 8-bit foreground color.

pub fn truecolor(self, red: u8, green: u8, blue: u8) -> Self

Use a truecolor foreground color.

pub fn on_black(self) -> Self

Use a black background color.

pub fn on_red(self) -> Self

Use a red background color.

pub fn on_green(self) -> Self

Use a green background color.

pub fn on_yellow(self) -> Self

Use a yellow background color.

pub fn on_blue(self) -> Self

Use a blue background color.

pub fn on_magenta(self) -> Self

Use a magenta background color.

pub fn on_cyan(self) -> Self

Use a cyan background color.

pub fn on_white(self) -> Self

Use a white background color.

pub fn on_bright_black(self) -> Self

Use a bright black background color.

pub fn on_bright_red(self) -> Self

Use a bright red background color.

pub fn on_bright_green(self) -> Self

Use a bright green background color.

pub fn on_bright_yellow(self) -> Self

Use a bright yellow background color.

pub fn on_bright_blue(self) -> Self

Use a bright blue background color.

pub fn on_bright_magenta(self) -> Self

Use a bright magenta background color.

pub fn on_bright_cyan(self) -> Self

Use a bright cyan background color.

pub fn on_bright_white(self) -> Self

Use a bright white background color.

pub fn custom_color(self, color: impl Into<CustomColor>) -> Self

Use an ANSI 8-bit background color.

pub fn on_custom_color(self, color: impl Into<CustomColor>) -> Self

Use a custom truecolor background color.

pub fn on_ansi_color(self, color: impl Into<u8>) -> Self

Use an ANSI 8-bit background color.

pub fn on_truecolor(self, red: u8, green: u8, blue: u8) -> Self

Use a truecolor background color.