Comfy-table

Comfy-table 被设计为一个易于使用的库，用于构建美观的终端表格。

目录

• 功能
• 示例
• 功能标志
• 贡献
• 不安全代码的使用
• 与其他库的比较

功能

• 根据给定宽度动态排列内容。
• 适用于终端的ANSI内容样式（颜色、粗体、闪烁等）。
• 提供样式预设和预设修改器以供您开始。
• 几乎可以自定义表格的每个部分（边框、行、填充、对齐）。
• 对列的限制允许您对内容的排列方式有更多控制。
• 跨平台（Linux、macOS、Windows）。
• 它足够快。
  • 基准测试表明，一个具有复杂约束的相当大的表格在 470μs 或 ~0.5ms 内构建。
  • 文档顶部的表格需要 ~30μs。
  • 这些数字来自一个超频的 i7-8700K，其单核最大性能为 4.9GHz。
  • 要运行自己的基准测试，请通过 cargo install cargo-criterion 安装 criterion，然后运行 cargo criterion。

Comfy-table是用当前的 stable Rust 版本编写的。较旧的 Rust 版本可能可以工作，但不受官方支持。

示例

use comfy_table::Table;

fn main() {
    let mut table = Table::new();
    table
        .set_header(vec!["Header1", "Header2", "Header3"])
        .add_row(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}");
}

创建一个非常基本的表格。
这个表格将变得与您的内容一样宽。这里没有任何特别之处。

+----------------------+----------------------+------------------------+
| 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     |                        |
+----------------------+----------------------+------------------------+

更多功能

use comfy_table::modifiers::UTF8_ROUND_CORNERS;
use comfy_table::presets::UTF8_FULL;
use comfy_table::*;

fn main() {
    let mut table = Table::new();
    table
        .load_preset(UTF8_FULL)
        .apply_modifier(UTF8_ROUND_CORNERS)
        .set_content_arrangement(ContentArrangement::Dynamic)
        .set_width(40)
        .set_header(vec!["Header1", "Header2", "Header3"])
        .add_row(vec![
            Cell::new("Center aligned").set_alignment(CellAlignment::Center),
            Cell::new("This is another text"),
            Cell::new("This is the third text"),
        ])
        .add_row(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}");
}

创建一个具有UTF8样式的表格，并应用一个提供圆角效果的修改器。
此外，内容将根据给定的表格宽度动态换行。
如果未明确设置表格宽度，并且程序在终端中运行，则将使用终端大小。

除此之外，我们还设置了右列的默认对齐方式为 Right，以及左上单元格的对齐方式为 Center。

╭────────────┬────────────┬────────────╮
│ 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      ┆            │
╰────────────┴────────────┴────────────╯

样式

use comfy_table::presets::UTF8_FULL;
use comfy_table::*;

fn main() {
    let mut table = Table::new();
    table.load_preset(UTF8_FULL)
        .set_content_arrangement(ContentArrangement::Dynamic)
        .set_width(80)
        .set_header(vec![
            Cell::new("Header1").add_attribute(Attribute::Bold),
            Cell::new("Header2").fg(Color::Green),
            Cell::new("Header3"),
        ])
        .add_row(vec![
             Cell::new("This is a bold text").add_attribute(Attribute::Bold),
             Cell::new("This is a green text").fg(Color::Green),
             Cell::new("This one has black background").bg(Color::Black),
        ])
        .add_row(vec![
            Cell::new("Blinky boi").add_attribute(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)
                .add_attributes(vec![
                    Attribute::Bold,
                    Attribute::SlowBlink,
                ])
        ]);

    println!("{table}");
}

此代码生成了文档顶部的表格。

代码示例

一些示例可以在 example 文件夹中找到。要测试一个示例，运行 cargo run --example $name. 例如。

cargo run --example readme_table