Struct Table

pub struct Table { /* private fields */ }

A paintable Table

The type can be thought of as Rows[Cols[Cells[Text]]], where the items inside a Cell will be concatenated together (alowing mixed formatting to exist within a table’s cell).

Warning: do not use \t in your text, as this currently uses tabwriter under the hood.

Examples

use termstyle::*;

let rows = vec![
    // header
    vec![
        vec![Text::new("header1".into())],
        vec![Text::new("header2".into())],
    ],
    // row1
    vec![
        vec![Text::new("col1".into())],
        vec![Text::new("col2".into())],
    ],
];
let example = Table::new(rows);

let expected = "\
header1 header2
col1    col2
";

let mut result = Vec::new();
example.paint(&mut result);

assert_eq!(expected.as_bytes(), result.as_slice());

Implementations

impl Table

pub fn new(table: Vec<Vec<Vec<Text>>>) -> Table

Create a new table from the given rows.

The type can be thought of as Rows[Cols[Cells[Text]]], where the items inside a Cell will be concatenated together (alowing mixed formatting to exist within a table’s cell).

pub fn set_plain(&mut self)

Recursively clears all formatting.

pub fn paint<W: Write>(&self, w: &mut W) -> Result<()>

Paint the table, giving each column the same width.

Trait Implementations

impl Debug for Table

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

Formats the value using the given formatter.

impl PartialEq for Table

fn eq(&self, other: &Table) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Table

impl StructuralPartialEq for Table