Struct nu_table::Table

pub struct Table { /* private fields */ }

Table represent a table view.

Implementations

impl Table

pub fn new( data: Vec<Vec<TCell<CellInfo<'static>, TextStyle>>>, size: (usize, usize) ) -> Table

Creates a Table instance.

If headers.is_empty then no headers will be rendered.

Examples found in repository

examples/table_demo.rs (line 36)

fn main() {
    let args: Vec<_> = std::env::args().collect();
    let mut width = 0;

    if args.len() > 1 {
        // Width in terminal characters
        width = args[1].parse::<usize>().expect("Need a width in columns");
    }

    if width < 4 {
        println!("Width must be greater than or equal to 4, setting width to 80");
        width = 80;
    }

    // The mocked up table data
    let (table_headers, row_data) = make_table_data();

    // The table headers
    let headers = vec_of_str_to_vec_of_styledstr(&table_headers, true);

    // The table rows
    let rows = vec_of_str_to_vec_of_styledstr(&row_data, false);

    // The table itself
    let count_cols = std::cmp::max(rows.len(), headers.len());
    let mut rows = vec![rows; 3];
    rows.insert(0, headers);

    let theme = TableTheme::rounded();
    let table_cfg = TableConfig::new(theme, true, false, false);

    let table = Table::new(rows, (3, count_cols));

    // Capture the table as a string
    let output_table = table
        .draw(table_cfg, width)
        .unwrap_or_else(|| format!("Couldn't fit table into {width} columns!"));

    // Draw the table
    println!("{output_table}")
}

pub fn count_rows(&self) -> usize

pub fn create_cell( text: impl Into<String>, style: TextStyle ) -> TCell<CellInfo<'static>, TextStyle>

Examples found in repository

examples/table_demo.rs (lines 93-96)

fn vec_of_str_to_vec_of_styledstr(
    data: &[&str],
    is_header: bool,
) -> Vec<TCell<CellInfo<'static>, TextStyle>> {
    let mut v = vec![];

    for x in data {
        if is_header {
            v.push(Table::create_cell(
                String::from(*x),
                TextStyle::default_header(),
            ))
        } else {
            v.push(Table::create_cell(
                String::from(*x),
                TextStyle::basic_left(),
            ))
        }
    }
    v
}

pub fn truncate(&mut self, width: usize, theme: &TableTheme) -> bool

pub fn draw(self, config: TableConfig, termwidth: usize) -> Option<String>

Converts a table to a String.

It returns None in case where table cannot be fit to a terminal width.

Examples found in repository

examples/table_demo.rs (line 40)

fn main() {
    let args: Vec<_> = std::env::args().collect();
    let mut width = 0;

    if args.len() > 1 {
        // Width in terminal characters
        width = args[1].parse::<usize>().expect("Need a width in columns");
    }

    if width < 4 {
        println!("Width must be greater than or equal to 4, setting width to 80");
        width = 80;
    }

    // The mocked up table data
    let (table_headers, row_data) = make_table_data();

    // The table headers
    let headers = vec_of_str_to_vec_of_styledstr(&table_headers, true);

    // The table rows
    let rows = vec_of_str_to_vec_of_styledstr(&row_data, false);

    // The table itself
    let count_cols = std::cmp::max(rows.len(), headers.len());
    let mut rows = vec![rows; 3];
    rows.insert(0, headers);

    let theme = TableTheme::rounded();
    let table_cfg = TableConfig::new(theme, true, false, false);

    let table = Table::new(rows, (3, count_cols));

    // Capture the table as a string
    let output_table = table
        .draw(table_cfg, width)
        .unwrap_or_else(|| format!("Couldn't fit table into {width} columns!"));

    // Draw the table
    println!("{output_table}")
}

Trait Implementations

impl Clone for Table

fn clone(&self) -> Table

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Table

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

Formats the value using the given formatter.