Struct minimad::TableBuilder

pub struct TableBuilder {
    pub cols: Vec<Col>,
    pub rows_sub_name: Option<String>,
}

A facility to build templates for tables

You can for example build a table this two ways:

with an explicit string:

static MD: &str = r#"
|-:|:-:|:-:|:-:|:-:|-:|:-:|:-:|:-|:-
|id|dev|filesystem|disk|type|used|use%|free|size|mount point
|-:|:-|:-|:-:|:-:|-:|-:|-:|:-
${rows
|${id}|${dev-major}:${dev-minor}|${filesystem}|${disk}|${type}|~~${used}~~|~~${use-percents}~~ `${bar}`|*${free}*|**${size}**|${mount-point}
}
|-:
"#;

with a table_builder:

 use minimad::{*, Alignment::*};

 let mut tbl = TableBuilder::default();
 tbl
     .col(Col::simple("id").align(Right))
     .col(Col::new("dev", "${dev-major}:${dev-minor}"))
     .col(Col::simple("filesystem"))
     .col(Col::simple("disk").align_content(Center))
     .col(Col::simple("type"))
     .col(Col::new("used", "~~${used}~~"))
     .col(Col::new("use%", "~~${use-percents}~~ `${bar}`").align_content(Right))
     .col(Col::new("free", "*${free}*").align(Right))
     .col(Col::new("size", "**${size}**"))
     .col(Col::simple("mount point").align(Left));

Both ways are mostly equivalent but a table builder makes it easier to dynamically define the columns.

(example taken from lfs)

Fields

cols: Vec<Col>

rows_sub_name: Option<String>

an optional name for the sub template for the rows. This is mostly useful when you want to concatenate table templates and you need to distinguish their subs

Implementations

impl TableBuilder

pub fn col(&mut self, col: Col) -> &mut Self

pub fn template_md(&self) -> String

build the string of a template of the table

Trait Implementations

impl Clone for TableBuilder

fn clone(&self) -> TableBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableBuilder

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

Formats the value using the given formatter.

impl Default for TableBuilder

fn default() -> TableBuilder

Returns the “default value” for a type.

impl From<&TableBuilder> for String

fn from(tblbl: &TableBuilder) -> String

Converts to this type from the input type.