Struct comfy_table::Column

pub struct Column {
    pub index: usize,
    // some fields omitted
}

A representation of a table's column. Useful for styling and specifying constraints how big a column should be.

1. Content padding for cells in this column
2. Constraints on how wide this column shall be
3. Default alignment for cells in this column

Columns are generated when adding rows or a header to a table.
As a result columns can only be modified after the table is populated by some data.

use comfy_table::{Table, ColumnConstraint, CellAlignment};

let mut table = Table::new();
table.set_header(&vec!["one", "two"]);

let mut column = table.get_column_mut(1).expect("This should be column two");

// Set the max width for all cells of this column to 20 characters.
column.set_constraint(ColumnConstraint::MaxWidth(20));

// Set the left padding to 5 spaces and the right padding to 1 space
column.set_padding((5, 1));

// Align content in all cells of this column to the center of the cell.
column.set_cell_alignment(CellAlignment::Center);

Fields

index: usize

The index of the column

Implementations

impl Column

pub fn new(index: usize) -> Self

pub fn set_padding(&mut self, padding: (u16, u16)) -> &mut Self

Set the padding for all cells of this column.

Padding is provided in the form of (left, right).
Default is (1, 1).

pub fn set_delimiter(&mut self, delimiter: char) -> &mut Self

Set the delimiter used to split text for this column's cells.

A custom delimiter on a cell in will overwrite the column's delimiter. The default is a simple space .

pub fn get_max_content_width(&self) -> u16

Get the width in characters of the widest line in this column.
This doesn't include padding yet!

pub fn get_max_width(&self) -> u16

Get the maximum possible width for this column.
This means widest line in this column + padding

pub fn set_constraint(&mut self, constraint: ColumnConstraint) -> &mut Self

Constraints allow to influence the auto-adjustment behavior of columns.
This can be useful to counter undesired auto-adjustment of content in tables.

pub fn get_constraint(&self) -> Option<&ColumnConstraint>

Get the constraint that is used for this column.

pub fn remove_constraint(&mut self) -> &mut Self

Remove any constraint on this column

pub fn set_cell_alignment(&mut self, alignment: CellAlignment)

Set the alignment for content inside of cells for this column.
Note: Alignment on a cell will always overwrite the column's setting.

Trait Implementations

impl Debug for Column

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

Formats the value using the given formatter.