Struct Style

Source

pub struct Style<T, B, L, R, H, V, HLines = [HorizontalLine; N], VLines = [VerticalLine; N]> { /* private fields */ }

Expand description

Style is represents a theme of a Table.

It tries to limit an controlling a valid state of it. It doesn’t allow to call method Style::top_left_corner unless Style::left and Style::top is set.

You can turn Style into RawStyle to have more controll using Into implementation.

§Example

use tabled::{Table, Style};

let style = Style::ascii()
                .bottom('*')
                .inner_intersection(' ');

let data = vec!["Hello", "2021"];
let table = Table::new(&data).with(style).to_string();

println!("{}", table);

Implementations§

Source §

impl Style<(), (), (), (), (), (), (), ()>

Source

pub const fn empty() -> Style<(), (), (), (), (), ()>

This style is a style with no styling options on,

     id  destribution            link
     0      Fedora      https://getfedora.org/
     2     OpenSUSE    https://www.opensuse.org/
     3   Endeavouros   https://endeavouros.com/

Note: The cells in the example have 1-left and 1-right indent.

This style can be used as a base style to build a custom one.

let style = Style::empty()
    .top('*')
    .bottom('*')
    .vertical('#')
    .bottom_intersection('^')
    .top_intersection('*');

Source

pub const fn blank() -> Style<(), (), (), (), (), On>

This style is analog of empty but with a vertical space(’ ’) line.

     id   destribution             link
     0       Fedora       https://getfedora.org/
     2      OpenSUSE     https://www.opensuse.org/
     3    Endeavouros    https://endeavouros.com/

Source

pub const fn ascii() -> Style<On, On, On, On, On, On>

This is a style which relays only on ASCII charset.

It has horizontal and vertical lines.

    +----+--------------+---------------------------+
    | id | destribution |           link            |
    +----+--------------+---------------------------+
    | 0  |    Fedora    |  https://getfedora.org/   |
    +----+--------------+---------------------------+
    | 2  |   OpenSUSE   | https://www.opensuse.org/ |
    +----+--------------+---------------------------+
    | 3  | Endeavouros  | https://endeavouros.com/  |
    +----+--------------+---------------------------+

Source

pub const fn psql() -> Style<(), (), (), (), (), On, [HorizontalLine; N]>

psql style looks like a table style PostgreSQL uses.

It has only 1 horizontal line which splits header. And no left and right vertical lines.

     id | destribution |           link
    ----+--------------+---------------------------
     0  |    Fedora    |  https://getfedora.org/
     2  |   OpenSUSE   | https://www.opensuse.org/
     3  | Endeavouros  | https://endeavouros.com/

Source

pub const fn markdown() -> Style<(), (), On, On, (), On, [HorizontalLine; N]>

markdown style mimics a Markdown table style.

    | id | destribution |           link            |
    |----|--------------|---------------------------|
    | 0  |    Fedora    |  https://getfedora.org/   |
    | 2  |   OpenSUSE   | https://www.opensuse.org/ |
    | 3  | Endeavouros  | https://endeavouros.com/  |

Source

pub const fn modern() -> Style<On, On, On, On, On, On>

This style is analog of Style::ascii which uses UTF-8 charset.

It has vertical and horizontal split lines.

    ┌────┬──────────────┬───────────────────────────┐
    │ id │ destribution │           link            │
    ├────┼──────────────┼───────────────────────────┤
    │ 0  │    Fedora    │  https://getfedora.org/   │
    ├────┼──────────────┼───────────────────────────┤
    │ 2  │   OpenSUSE   │ https://www.opensuse.org/ │
    ├────┼──────────────┼───────────────────────────┤
    │ 3  │ Endeavouros  │ https://endeavouros.com/  │
    └────┴──────────────┴───────────────────────────┘

Source

pub const fn sharp() -> Style<On, On, On, On, (), On, [HorizontalLine; N]>

This style looks like a Style::modern but without horozizontal lines except a header.

Beware: It uses UTF-8 characters.

    ┌────┬──────────────┬───────────────────────────┐
    │ id │ destribution │           link            │
    ├────┼──────────────┼───────────────────────────┤
    │ 0  │    Fedora    │  https://getfedora.org/   │
    │ 2  │   OpenSUSE   │ https://www.opensuse.org/ │
    │ 3  │ Endeavouros  │ https://endeavouros.com/  │
    └────┴──────────────┴───────────────────────────┘

Source

pub const fn rounded() -> Style<On, On, On, On, (), On, [HorizontalLine; N]>

This style looks like a Style::sharp but with rounded corners.

Beware: It uses UTF-8 characters.

    ╭────┬──────────────┬───────────────────────────╮
    │ id │ destribution │           link            │
    ├────┼──────────────┼───────────────────────────┤
    │ 0  │    Fedora    │  https://getfedora.org/   │
    │ 2  │   OpenSUSE   │ https://www.opensuse.org/ │
    │ 3  │ Endeavouros  │ https://endeavouros.com/  │
    ╰────┴──────────────┴───────────────────────────╯

Source

pub const fn extended() -> Style<On, On, On, On, On, On>

This style uses a chars which resembles ‘2 lines’.

Beware: It uses UTF8 characters.

    ╔════╦══════════════╦═══════════════════════════╗
    ║ id ║ destribution ║           link            ║
    ╠════╬══════════════╬═══════════════════════════╣
    ║ 0  ║    Fedora    ║  https://getfedora.org/   ║
    ╠════╬══════════════╬═══════════════════════════╣
    ║ 2  ║   OpenSUSE   ║ https://www.opensuse.org/ ║
    ╠════╬══════════════╬═══════════════════════════╣
    ║ 3  ║ Endeavouros  ║ https://endeavouros.com/  ║
    ╚════╩══════════════╩═══════════════════════════╝

Source

pub const fn dots() -> Style<On, On, On, On, On, On>

This is a style uses only ‘.’ and ‘:’ chars. It has a vertical and horizontal split lines.

    .................................................
    : id : destribution :           link            :
    :....:..............:...........................:
    : 0  :    Fedora    :  https://getfedora.org/   :
    :....:..............:...........................:
    : 2  :   OpenSUSE   : https://www.opensuse.org/ :
    :....:..............:...........................:
    : 3  : Endeavouros  : https://endeavouros.com/  :
    :....:..............:...........................:

Source

pub const fn re_structured_text() -> Style<On, On, (), (), (), On, [HorizontalLine; N]>

This style is one of table views in ReStructuredText.

    ==== ============== ===========================
     id   destribution             link            
    ==== ============== ===========================
     0       Fedora       https://getfedora.org/   
     2      OpenSUSE     https://www.opensuse.org/
     3    Endeavouros    https://endeavouros.com/  
    ==== ============== ===========================

Source

pub const fn ascii_rounded() -> Style<On, On, On, On, (), On>

This is a theme analog of Style::rounded, but in using ascii charset and with no horizontal lines.

    .-----------------------------------------------.
    | id | destribution |           link            |
    | 0  |    Fedora    |  https://getfedora.org/   |
    | 2  |   OpenSUSE   | https://www.opensuse.org/ |
    | 3  | Endeavouros  | https://endeavouros.com/  |
    '-----------------------------------------------'

Source

pub const fn correct_spans() -> StyleCorrectSpan

Try to fix the style when table contains spans.

By default Style doesn’t implies any logic to better render split lines when Span is used.

So this function can be used to set the split lines in regard of spans used.

§Example

use tabled::{TableIteratorExt, Style, Modify, format::Format, Span, object::Cell};

let data = vec![
    ("09", "June", "2022"),
    ("10", "July", "2022"),
];

let mut table = data.table();
table
    .with(
        Modify::new(Cell(0, 0))
            .with(Format::new(|_| String::from("date")))
            .with(Span::column(3))
    );

assert_eq!(
    table.to_string(),
    concat!(
        "+----+------+------+\n",
        "| date             |\n",
        "+----+------+------+\n",
        "| 09 | June | 2022 |\n",
        "+----+------+------+\n",
        "| 10 | July | 2022 |\n",
        "+----+------+------+",
    )
);

table.with(Style::correct_spans());

assert_eq!(
    table.to_string(),
    concat!(
        "+------------------+\n",
        "| date             |\n",
        "+----+------+------+\n",
        "| 09 | June | 2022 |\n",
        "+----+------+------+\n",
        "| 10 | July | 2022 |\n",
        "+----+------+------+",
    )
);

Source §

impl<T, B, L, R, H, V, HLines, VLines> Style<T, B, L, R, H, V, HLines, VLines>

Source

pub const fn get_frame(&self) -> Border

Frame function returns a frame as a border.

§Example

use tabled::{Table, Style, Highlight, object::Rows};

let data = [["10:52:19", "Hello"], ["10:52:20", "World"]];
let mut table = Table::new(data);
table.with(Highlight::new(Rows::first(), Style::modern().get_frame()));

assert_eq!(
    table.to_string(),
    concat!(
        "┌──────────────────┐\n",
        "│ 0        | 1     │\n",
        "└──────────────────┘\n",
        "| 10:52:19 | Hello |\n",
        "+----------+-------+\n",
        "| 10:52:20 | World |\n",
        "+----------+-------+",
    )
);

Source

pub const fn get_horizontal(&self) -> Line

Get a Style’s default horizontal line.

It doesn’t return an overloaded line via Style::horizontals.

§Example

use tabled::{style::{Style, HorizontalLine, Line}, TableIteratorExt};

let table = (0..3)
   .map(|i| ("Hello", "World", i))
   .table()
   .with(Style::ascii().off_horizontal().horizontals([HorizontalLine::new(1, Style::modern().get_horizontal())]))
   .to_string();

assert_eq!(
    table,
    concat!(
        "+-------+-------+-----+\n",
        "| &str  | &str  | i32 |\n",
        "├───────┼───────┼─────┤\n",
        "| Hello | World | 0   |\n",
        "| Hello | World | 1   |\n",
        "| Hello | World | 2   |\n",
        "+-------+-------+-----+",
    )
)

Source

pub const fn get_vertical(&self) -> Line

Get a Style’s default horizontal line.

It doesn’t return an overloaded line via Style::verticals.

§Example

use tabled::{style::{Style, VerticalLine, Line}, TableIteratorExt};

let table = (0..3)
   .map(|i| ("Hello", "World", i))
   .table()
   .with(Style::ascii().off_horizontal().verticals([VerticalLine::new(1, Style::modern().get_vertical())]))
   .to_string();

assert_eq!(
    table,
    concat!(
        "+-------┬-------+-----+\n",
        "| &str  │ &str  | i32 |\n",
        "| Hello │ World | 0   |\n",
        "| Hello │ World | 1   |\n",
        "| Hello │ World | 2   |\n",
        "+-------┴-------+-----+",
    )
)

Source