Struct nu_table::NuTable

pub struct NuTable { /* private fields */ }

NuTable is a table rendering implementation.

Implementations

impl NuTable

pub fn new(count_rows: usize, count_columns: usize) -> Self

Creates an empty NuTable instance.

pub fn count_rows(&self) -> usize

Return amount of rows.

pub fn count_columns(&self) -> usize

Return amount of columns.

pub fn insert(&mut self, pos: Position, text: String)

pub fn set_column_style(&mut self, column: usize, style: TextStyle)

pub fn insert_style(&mut self, pos: Position, style: TextStyle)

pub fn set_header_style(&mut self, style: TextStyle)

Examples found in repository

examples/table_demo.rs (line 30)

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

    if args.len() > 1 {
        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;
    }

    let (table_headers, row_data) = make_table_data();

    let headers = to_cell_info_vec(&table_headers);
    let rows = to_cell_info_vec(&row_data);

    let mut rows = vec![rows; 3];
    rows.insert(0, headers);

    let mut table = NuTable::from(rows);

    table.set_data_style(TextStyle::basic_left());
    table.set_header_style(TextStyle::basic_center().style(Style::new().on(Color::Blue)));

    let table_cfg = NuTableConfig {
        theme: TableTheme::rounded(),
        with_header: true,
        ..Default::default()
    };

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

    println!("{output_table}")
}

pub fn set_index_style(&mut self, style: TextStyle)

pub fn set_data_style(&mut self, style: TextStyle)

Examples found in repository

examples/table_demo.rs (line 29)

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

    if args.len() > 1 {
        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;
    }

    let (table_headers, row_data) = make_table_data();

    let headers = to_cell_info_vec(&table_headers);
    let rows = to_cell_info_vec(&row_data);

    let mut rows = vec![rows; 3];
    rows.insert(0, headers);

    let mut table = NuTable::from(rows);

    table.set_data_style(TextStyle::basic_left());
    table.set_header_style(TextStyle::basic_center().style(Style::new().on(Color::Blue)));

    let table_cfg = NuTableConfig {
        theme: TableTheme::rounded(),
        with_header: true,
        ..Default::default()
    };

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

    println!("{output_table}")
}

pub fn set_indent(&mut self, left: usize, right: usize)

pub fn get_records_mut(&mut self) -> &mut VecRecords<NuTableCell>

pub fn draw(self, config: NuTableConfig, 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 39)

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

    if args.len() > 1 {
        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;
    }

    let (table_headers, row_data) = make_table_data();

    let headers = to_cell_info_vec(&table_headers);
    let rows = to_cell_info_vec(&row_data);

    let mut rows = vec![rows; 3];
    rows.insert(0, headers);

    let mut table = NuTable::from(rows);

    table.set_data_style(TextStyle::basic_left());
    table.set_header_style(TextStyle::basic_center().style(Style::new().on(Color::Blue)));

    let table_cfg = NuTableConfig {
        theme: TableTheme::rounded(),
        with_header: true,
        ..Default::default()
    };

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

    println!("{output_table}")
}

pub fn total_width(&self, config: &NuTableConfig) -> usize

Return a total table width.

Trait Implementations

impl Clone for NuTable

fn clone(&self) -> NuTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NuTable

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

Formats the value using the given formatter.

impl From<Vec<Vec<CellInfo<String>>>> for NuTable

fn from(value: Vec<Vec<CellInfo<String>>>) -> Self

Converts to this type from the input type.