Struct Table 

pub struct Table { /* private fields */ }

A console-renderable table with rows and columns.

Table supports headers, footers, various border styles, and flexible column width calculation.

Example

use rich_rs::Table;

let mut table = Table::new();
table.add_column_str("Name");
table.add_column_str("Score");
table.add_row_strs(&["Alice", "100"]);
table.add_row_strs(&["Bob", "95"]);

Implementations

impl Table

pub fn new() -> Self

Create a new empty table with default settings.

The default table uses HEAVY_HEAD border style, shows headers, and has standard padding.

pub fn grid() -> Self

Create a grid (table with no borders or header).

A grid is useful for simple layouts without table decoration.

pub fn with_box(self, box_type: Option<RichBox>) -> Self

Set the border style.

pub fn with_safe_box(self, safe: bool) -> Self

Set whether to use ASCII-safe box characters.

pub fn with_padding(self, left: usize, right: usize) -> Self

Set cell padding (left and right), keeping top/bottom at 0.

For full 4-way padding, use with_padding_dims.

pub fn with_padding_dims(self, pad: impl Into<PaddingDimensions>) -> Self

Set cell padding using CSS-order dimensions.

Accepts PaddingDimensions (or anything that converts to it):

• usize — all four sides
• (vert, horiz) — top/bottom and left/right
• (top, right, bottom, left) — CSS order

pub fn with_title_style(self, style: Style) -> Self

Set the title style.

pub fn with_caption_style(self, style: Style) -> Self

Set the caption style.

pub fn with_collapse_padding(self, collapse: bool) -> Self

Set whether to collapse padding between cells.

pub fn with_pad_edge(self, pad: bool) -> Self

Set whether to pad edge cells.

pub fn with_expand(self, expand: bool) -> Self

Set whether to expand to fill available width.

pub fn with_show_header(self, show: bool) -> Self

Set whether to show the header row.

pub fn with_show_footer(self, show: bool) -> Self

Set whether to show the footer row.

pub fn with_show_edge(self, show: bool) -> Self

Set whether to show the outer edge.

pub fn with_show_lines(self, show: bool) -> Self

Set whether to show lines between all rows.

pub fn with_leading(self, leading: usize) -> Self

Set number of blank lines between rows.

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

Set the base table style.

pub fn with_row_styles(self, styles: Vec<Style>) -> Self

Set alternating row styles.

pub fn with_header_style(self, style: Style) -> Self

Set the header style.

pub fn with_footer_style(self, style: Style) -> Self

Set the footer style.

pub fn with_border_style(self, style: Style) -> Self

Set the border style.

pub fn with_title(self, title: &str) -> Self

Set the title above the table.

pub fn with_title_text(self, title: Text) -> Self

Set the title with a Text object.

pub fn with_caption(self, caption: &str) -> Self

Set the caption below the table.

pub fn with_caption_text(self, caption: Text) -> Self

Set the caption with a Text object.

pub fn with_title_align(self, align: AlignMethod) -> Self

Set title alignment.

pub fn with_caption_align(self, align: AlignMethod) -> Self

Set caption alignment.

pub fn with_width(self, width: usize) -> Self

Set a fixed width for the table.

pub fn with_min_width(self, width: usize) -> Self

Set the minimum width.

pub fn with_highlight(self, highlight: bool) -> Self

Set whether to highlight cell contents.

pub fn add_column(&mut self, column: Column)

Add a column to the table.

pub fn add_column_str(&mut self, header: &str)

Add a column with a string header.

pub fn add_column_renderable( &mut self, header: Box<dyn Renderable + Send + Sync>, )

Add a column with a renderable header.

pub fn add_row(&mut self, row: Row)

Add a row of cells to the table.

pub fn add_row_strs(&mut self, cells: &[&str])

Add a row of string cells.

pub fn add_row_renderables( &mut self, cells: Vec<Box<dyn Renderable + Send + Sync>>, )

Add a row of renderable cells.

pub fn add_section(&mut self)

Mark the last row as an end-of-section (draws separator after).

pub fn row_count(&self) -> usize

Get the number of rows (excluding header/footer).

pub fn column_count(&self) -> usize

Get the number of columns.

pub fn set_title(&mut self, title: Option<Text>)

Set the table title.

pub fn set_caption(&mut self, caption: Option<Text>)

Set the table caption.

pub fn set_show_footer(&mut self, show: bool)

Set whether to show the footer row.

pub fn set_border_style(&mut self, style: Style)

Set the border style.

pub fn set_box(&mut self, box_type: Option<RichBox>)

Set the box drawing style.

pub fn set_row_styles(&mut self, styles: Vec<Style>)

Set alternating row styles.

pub fn set_pad_edge(&mut self, pad: bool)

Set whether to pad the edge cells.

pub fn set_width(&mut self, width: Option<usize>)

Set the fixed width (None for auto).

pub fn column_mut(&mut self, idx: usize) -> Option<&mut Column>

Get a mutable reference to a column by index.

Trait Implementations

impl Debug for Table

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

Formats the value using the given formatter.

impl Default for Table

fn default() -> Self

Returns the “default value” for a type.

impl Renderable for Table

fn render( &self, console: &Console<Stdout>, options: &ConsoleOptions, ) -> Segments

Render this object to a sequence of segments.

fn measure( &self, console: &Console<Stdout>, options: &ConsoleOptions, ) -> Measurement

Measure the minimum and maximum width requirements.