Struct Builder

Source

pub struct Builder { /* private fields */ }

Expand description

Builder creates a Table from dynamic data set.

It useful when the amount of columns or rows is not known statically.

use tabled::builder::Builder;

let mut builder = Builder::default();
builder.push_record(["index", "measure", "value"]);
builder.push_record(["0", "weight", "0.443"]);

let table = builder.build();

println!("{}", table);

It may be useful to use FromIterator for building.

use tabled::builder::Builder;
use std::iter::FromIterator;

let data = vec![
    ["column1", "column2"],
    ["data1", "data2"],
    ["data3", "data4"],
];

let table = Builder::from_iter(data).build();

println!("{}", table);

Implementations§

Source §

impl Builder

Source

pub fn new() -> Builder

Creates a Builder instance.

use tabled::builder::Builder;

let builder = Builder::new();

Source

pub fn with_capacity(count_records: usize, count_columns: usize) -> Builder

Creates a Builder instance with a given row capacity.

use tabled::builder::Builder;

let mut builder = Builder::with_capacity(2, 3);
builder.push_record((0..3).map(|i| i.to_string()));
builder.push_record(["i", "surname", "lastname"]);

Source

pub fn from_vec(data: Vec<Vec<Text<String>>>) -> Builder

Creates a Builder instance.

§Safety

It’s marked unsafe to emphasize that you shall make sure that all rows bound to have the same length.

use tabled::builder::Builder;

let data = vec![];
let builder = Builder::from_vec(data);

Source

pub fn set_empty<T>(&mut self, text: T)
where T: Into<String>,

Sets a content of cells which are created in case rows has different length.

use tabled::builder::Builder;

let mut builder = Builder::default();
builder.set_empty("undefined");
builder.push_record((0..3).map(|i| i.to_string()));
builder.push_record(["i"]);

Source

pub fn build(self) -> Table

Build creates a Table instance.

use tabled::builder::Builder;

let mut builder = Builder::default();
builder.push_record(["i", "column1", "column2"]);
builder.push_record(["0", "value1", "value2"]);

Source

pub fn index(self) -> IndexBuilder

Add an index to the Table.

Default index is a range 0-N where N is amount of records.

§Example

use tabled::Table;

let table = Table::builder(&["Hello", "World", "!"]).index().build();

assert_eq!(
    table.to_string(),
    "+---+-------+\n\
     |   | &str  |\n\
     +---+-------+\n\
     | 0 | Hello |\n\
     +---+-------+\n\
     | 1 | World |\n\
     +---+-------+\n\
     | 2 | !     |\n\
     +---+-------+"
)

Source

pub fn push_record<R>(&mut self, record: R)
where R: IntoIterator, <R as IntoIterator>::Item: Into<String>,

Adds a row to a Table.

use tabled::builder::Builder;

let mut builder = Builder::default();
builder.push_record((0..3).map(|i| i.to_string()));
builder.push_record(["i", "surname", "lastname"]);

Source

pub fn insert_record<R>(&mut self, index: usize, record: R)
where R: IntoIterator, <R as IntoIterator>::Item: Into<String>,

Insert a row into a specific position.

§Panics

Panics if index > count_rows.

Source

pub fn clean(&mut self)

Clean removes empty columns and rows.

§Example

use tabled::Table;

let mut builder = Table::builder(&["Hello", "World", ""]);
builder.clean();

let table = builder.build();

assert_eq!(
    table.to_string(),
    "+-------+\n\
     | &str  |\n\
     +-------+\n\
     | Hello |\n\
     +-------+\n\
     | World |\n\
     +-------+"
)

Source

pub fn remove_record(&mut self, index: usize)

Removes a row with a specific position.

Index expected to be in range. Builder::count_records() < x >= 0

§Panics

Panics if row_index > count_rows.

Source

pub fn remove_column(&mut self, index: usize)

Removes a column with a specific position.

Index expected to be in range. Builder::count_columns() < x >= 0

§Panics

Panics if index > count_columns.

Source

pub fn push_column(&mut self, column: I)
where I: IntoIterator, ::Item: Into<String>,

Push a column.

Source

pub fn insert_column(&mut self, index: usize, column: I)
where I: IntoIterator, ::Item: Into<String>,

Insert a column with a specific position.

In case a column is bigger then the total amount of rows it will be truncated.

§Panics

Panics if index > count_columns.

Source

pub fn clear(&mut self)

Remove all records.

Source

pub fn count_columns(&self) -> usize

Returns an amount of columns which would be present in a built table.

Source

pub fn count_records(&self) -> usize

Returns an amount of rows which would be present in a built table.

Notice that it does not include header if present; It returns only amount of records.

Trait Implementations§

Source §

impl Clone for Builder

Source §

fn clone(&self) -> Builder

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Builder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Builder

Source §

fn default() -> Builder

Returns the “default value” for a type. Read more

Source §

impl<D> Extend<D> for Builder
where D: Into<String>,

Source §

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = D>,

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

Source §

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

Source §