Struct Style

Source

pub struct Style<T, B, L, R, H, V, const HSIZE: usize, const VSIZE: usize> { /* private fields */ }

Expand description

Style is represents a theme of a Table.

corner top left         top intersection                    corner top right
               .             |                             .
                .            V                            .
                 ╭───┬───┬───┬───┬───┬───┬────┬────┬────╮
                 │ i │ 0 │ 1 │ 2 │ 3 │ 4 │ 5  │ 6  │ 7  │
                 ├───┼───┼───┼───┼───┼───┼────┼────┼────┤ <- this horizontal line is custom 'horizontals'
                 │ 0 │ 0 │ 0 │ 0 │ 0 │ 0 │ 0  │ 0  │ 0  │    other lines horizontal lines are not set they called 'horizontal'
                 │ 1 │ 0 │ 1 │ 2 │ 3 │ 4 │ 5  │ 6  │ 7  │
                 │ 2 │ 0 │ 2 │ 4 │ 6 │ 8 │ 10 │ 12 │ 14 │
                 ╰───┴───┴───┴───┴───┴───┴────┴────┴────╯
               .         ^                    ^           .
              .          |                    |            .
corner bottom left       |         bottom intersection     corner bottom right
                         |
                         |
            all this vertical lines are called 'vertical'

                    ┌───┬───┬───┬───┬───┐
                    │ 0 │ 1 │ 2 │ 3 │ 4 │
intersection left ->├───X───X───X───X───┤ <- all this horizontal lines are called 'horizontal'
                    │ 1 │ 2 │ 3 │ 4 │ 5 │
                    ├───X───X───X───X───┤ <- intersection right
                    │ 2 │ 3 │ 4 │ 5 │ 6 │
                    └───┴───┴───┴───┴───┘

All 'X' positions are called 'intersection'.
It's a place where 'vertical' and 'horizontal' lines intersect.

It tries to limit an controlling a valid state of it. For example, it won’t allow to call method Style::corner_top_left unless Style::left and Style::top is set.

You can turn Style into Theme to have a precise control using Into implementation.

§Example

use tabled::{Table, settings::style::Style};

let data = vec!["Hello", "2021"];
let mut table = Table::new(&data);

let style = Style::ascii().bottom('*').intersection(' ');
table.with(style);

println!("{}", table);

Implementations§

Source §

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

Source

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

This style is a style with no styling options on,

     id  distribution            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('#')
    .intersection_top('*');

Source

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

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

     id   distribution             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, 0, 0>

This is a style which relays only on ASCII charset.

It has horizontal and vertical lines.

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

Source

pub const fn psql() -> Style<(), (), (), (), (), On, 1, 0>

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 | distribution |           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, 1, 0>

markdown style mimics a Markdown table style.

    | id | distribution |           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, 0, 0>

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

It has vertical and horizontal split lines.

    ┌────┬──────────────┬───────────────────────────┐
    │ id │ distribution │           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, 1, 0>

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

Beware: It uses UTF-8 characters.

    ┌────┬──────────────┬───────────────────────────┐
    │ id │ distribution │           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, 1, 0>

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

Beware: It uses UTF-8 characters.

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

Source

pub const fn modern_rounded() -> Style<On, On, On, On, On, On, 0, 0>

This style looks like a Style::rounded but with horizontals lines.

Beware: It uses UTF-8 characters.

    ╭────┬──────────────┬───────────────────────────╮
    │ id │ distribution │           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, 0, 0>

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

Beware: It uses UTF8 characters.

    ╔════╦══════════════╦═══════════════════════════╗
    ║ id ║ distribution ║           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, 0, 0>

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

    .................................................
    : id : distribution :           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, 1, 0>

This style is one of table views in ReStructuredText.

    ==== ============== ===========================
     id   distribution             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, 0, 0>

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

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

Source §

impl<T, B, L, R, H, V, const HN: usize, const VN: usize> Style<T, B, L, R, H, V, HN, VN>

Source

pub const fn horizontals<const SIZE: usize>( self, list: [(usize, HorizontalLine<L, R, V>); SIZE], ) -> Style<T, B, L, R, H, V, SIZE, VN>

Set border horizontal lines.

§Example

use tabled::{settings::style::{Style, HorizontalLine}, Table};

let data = (0..3).map(|i| ("Hello", i));
let mut table = Table::new(data);

let style = Style::rounded().horizontals([
    (1, HorizontalLine::filled('#')),
    (2, HorizontalLine::filled('&')),
    (3, HorizontalLine::filled('@')),
]);

table.with(style);

assert_eq!(
    table.to_string(),
    concat!(
        "╭───────┬─────╮\n",
        "│ &str  │ i32 │\n",
        "###############\n",
        "│ Hello │ 0   │\n",
        "&&&&&&&&&&&&&&&\n",
        "│ Hello │ 1   │\n",
        "@@@@@@@@@@@@@@@\n",
        "│ Hello │ 2   │\n",
        "╰───────┴─────╯",
    )
)

Source

pub const fn verticals<const SIZE: usize>( self, list: [(usize, VerticalLine<T, B, H>); SIZE], ) -> Style<T, B, L, R, H, V, HN, SIZE>

Set border vertical lines.

§Example

use tabled::{settings::style::{Style, VerticalLine}, Table};

let data = (0..3).map(|i| ("Hello", "World", i));
let mut table = Table::new(data);

let style = Style::rounded().verticals([
    (1, VerticalLine::new('#').top(':').bottom('.')),
    (2, VerticalLine::new('&').top(':').bottom('.')),
]);
let table = table.with(style).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 remove_horizontals(self) -> Style<T, B, L, R, H, V, 0, VN>

Removes all horizontal lines set by Style::horizontals

Source

pub const fn remove_verticals(self) -> Style<T, B, L, R, H, V, HN, 0>

Removes all verticals lines set by Style::verticals

Source