Comfy-table is designed as a library for building beautiful tables, while being easy to use.
470μs or ~0.5ms.~30μs.i7-8700K with a max single-core performance of 4.9GHz.cargo install cargo-criterion and run cargo criterion afterwards.Comfy-table is written for the current stable Rust version.
Older Rust versions may work but aren't officially supported.
```rust use comfy_table::Table;
fn main() { let mut table = Table::new(); table .setheader(vec!["Header1", "Header2", "Header3"]) .addrow(vec![ "This is a text", "This is another text", "This is the third text", ]) .add_row(vec![ "This is another text", "Now\nadd some\nmulti line stuff", "This is awesome", ]);
println!("{table}");
} ```
Create a very basic table.\ This table will become as wide as your content. Nothing fancy happening here.
text,ignore
+----------------------+----------------------+------------------------+
| Header1 | Header2 | Header3 |
+======================================================================+
| This is a text | This is another text | This is the third text |
|----------------------+----------------------+------------------------|
| This is another text | Now | This is awesome |
| | add some | |
| | multi line stuff | |
+----------------------+----------------------+------------------------+
```rust use comfytable::*; use comfytable::presets::UTF8FULL; use comfytable::modifiers::UTF8ROUNDCORNERS;
fn main() { let mut table = Table::new(); table .loadpreset(UTF8FULL) .applymodifier(UTF8ROUNDCORNERS) .setcontentarrangement(ContentArrangement::Dynamic) .setwidth(40) .setheader(vec!["Header1", "Header2", "Header3"]) .addrow(vec![ Cell::new("Center aligned").setalignment(CellAlignment::Center), Cell::new("This is another text"), Cell::new("This is the third text"), ]) .addrow(vec![ "This is another text", "Now\nadd some\nmulti line stuff", "This is awesome", ]);
// Set the default alignment for the third column to right
let column = table.column_mut(2).expect("Our table has three columns");
column.set_cell_alignment(CellAlignment::Right);
println!("{table}");
} ```
Create a table with UTF8 styling, and apply a modifier that gives the table round corners.\ Additionally, the content will dynamically wrap to maintain a given table width.\ If the table width isn't explicitely set and the program runs in a terminal, the terminal size will be used.
On top of this, we set the default alignment for the right column to Right and the alignment of the left top cell to Center.
text,ignore
╭────────────┬────────────┬────────────╮
│ Header1 ┆ Header2 ┆ Header3 │
╞════════════╪════════════╪════════════╡
│ This is a ┆ This is ┆ This is │
│ text ┆ another ┆ the third │
│ ┆ text ┆ text │
├╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌┤
│ This is ┆ Now ┆ This is │
│ another ┆ add some ┆ awesome │
│ text ┆ multi line ┆ │
│ ┆ stuff ┆ │
╰────────────┴────────────┴────────────╯
```rust use comfytable::*; use comfytable::presets::UTF8_FULL;
fn main() { let mut table = Table::new(); table.loadpreset(UTF8FULL) .setcontentarrangement(ContentArrangement::Dynamic) .setwidth(80) .setheader(vec![ Cell::new("Header1").addattribute(Attribute::Bold), Cell::new("Header2").fg(Color::Green), Cell::new("Header3"), ]) .addrow(vec![ Cell::new("This is a bold text").addattribute(Attribute::Bold), Cell::new("This is a green text").fg(Color::Green), Cell::new("This one has black background").bg(Color::Black), ]) .addrow(vec![ Cell::new("Blinky boi").addattribute(Attribute::SlowBlink), Cell::new("This table's content is dynamically arranged. The table is exactly 80 characters wide.\nHere comes a reallylongwordthatshoulddynamicallywrap"), Cell::new("COMBINE ALL THE THINGS") .fg(Color::Green) .bg(Color::Black) .addattributes(vec![ Attribute::Bold, Attribute::SlowBlink, ]) ]);
println!("{table}");
} ```
This code generates the table that can be seen at the top of this document.
A few examples can be found in the example folder.
To test an example, run cargo run --example $name. E.g.:
bash
cargo run --example readme_table
If you're looking for more information, take a look at the tests folder.
There are tests for almost every feature including a visual view for each resulting table.
Comfy-table is supposed to be minimalistic. A fixed set of features that just work for "normal" use-cases:
If you come up with an idea or an improvement that fits into the current scope of the project, feel free to create an issue :)!
Some things however will most likely not be added to the project since they drastically increase the complexity of the library or cover very specific edge-cases.
Such features are:
Comfy-table doesn't allow unsafe code in its code-base.
As it's a "simple" formatting library it also shouldn't be needed in the future.
However, Comfy-table uses two unsafe functions calls in its dependencies. \ Both calls can be disabled by explicitely calling Table::forcenotty.
Furthermore, all terminal related functionality, including styling, can be disabled by excluding the tty feature flag.
Without this flag no unsafe code is used as far as I know.
crossterm::tty::IsTty. This function is necessary to detect whether we're currently on a tty or not.
This is only called if no explicit width is provided via Table::set_width.
rust,ignore
/// On unix the `isatty()` function returns true if a file
/// descriptor is a terminal.
#[cfg(unix)]
impl<S: AsRawFd> IsTty for S {
fn is_tty(&self) -> bool {
let fd = self.as_raw_fd();
unsafe { libc::isatty(fd) == 1 }
}
}
crossterm::terminal::size. This function is necessary to detect the current terminal width if we're on a tty.
This is only called if no explicit width is provided via Table::set_width.
http://rosettacode.org/wiki/Terminalcontrol/Dimensions#Library:BSD_libc
This is another libc call which is used to communicate with /dev/tty via a file descriptor.
rust,ignore
...
if wrap_with_result(unsafe { ioctl(fd, TIOCGWINSZ.into(), &mut size) }).is_ok() {
Ok((size.ws_col, size.ws_row))
} else {
tput_size().ok_or_else(|| std::io::Error::last_os_error().into())
}
...