vilayat-ali / pretty-table-rs Goto Github PK

Pretty Table is a Rust crate designed to make your life easier when it comes to formatting and displaying 2-D vectors in a visually appealing tabular format. Whether you're working with strings, numbers, or custom types that implement the Into<String> trait, Pretty Table has got you covered.

• Versatile Input: Works with any type that implements the Into<String> trait.

• Beautiful Output: Transform your 2-D vectors into visually pleasing tables.

• Console and File Output: Display your tables in the console or write them to a file effortlessly.

Add Pretty Table to your Cargo.toml file:

[dependencies]
pretty-table = "0.1.3"

Or, run the command at the root of your project

cargo add pretty-table

Consider this quick example to get started.

use pretty_table::prelude::*;

fn main() {
    // define your table as 2-D vectors where all vectors must have `EQUAL` lengths
    let table_data = vec![
        vec!["Name", "Age", "Salary"], // header
        vec!["Altmann", "45", "11.0k"],
        vec!["Bezos", "32", "99.34k"],
        vec!["Pichai", "56", "9.9m"],
        vec!["Cook", "43", "8.2m"],
    ];

    // print to terminal/standard output
    print_table!(table_data.clone());

    // write to file
    write_table_to_file("table.txt", table_data);
}

Output:

+=========+=====+========+
|  Name   | Age | Salary |
+=========+=====+========+
| Altmann | 45  | 11.0k  |
+---------+-----+--------+
|  Bezos  | 32  | 99.34k |
+---------+-----+--------+
| Pichai  | 56  |  9.9m  |
+---------+-----+--------+
|  Cook   | 43  |  8.2m  |
+---------+-----+--------+

Explore more examples at /examples directory in this repository.

For more in-depth information, check out the documentation.

We welcome contributions! If you have any ideas, bug fixes, or improvements, feel free to open an issue or submit a pull request.

This project is licensed under the MIT License.