Struct Height

Source

pub struct Height;

Expand description

Height is a abstract factory for height settings.

§Example

use tabled::{Table, settings::{Height, Settings}};

let data = vec![
    ("Some data", "here", "and here"),
    ("Some data on a next", "line", "right here"),
];

let table = Table::new(data)
    .with(Settings::new(Height::limit(10), Height::increase(10)))
    .to_string();

assert_eq!(
    table,
    "+---------------------+------+------------+\n\
     | &str                | &str | &str       |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data           | here | and here   |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data on a next | line | right here |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+",
)

Implementations§

Source §

impl Height

Source

pub fn increase<W: Measurement<Height>>(height: W) -> CellHeightIncrease<W>

Create CellHeightIncrease to set a table/cell height.

§Example

§Cell height

use tabled::{Table, settings::{Height, Modify, object::Columns}};

let data = vec![
    ("Some data", "here", "and here"),
    ("Some data on a next", "line", "right here"),
];

let table = Table::new(data)
    .with(Modify::new(Columns::first()).with(Height::increase(5)))
    .to_string();

assert_eq!(
    table,
    "+---------------------+------+------------+\n\
     | &str                | &str | &str       |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data           | here | and here   |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data on a next | line | right here |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+"
)

§Table height

use tabled::{Table, settings::Height};

let data = vec![
    ("Some data", "here", "and here"),
    ("Some data on a next", "line", "right here"),
];

let table = Table::new(data)
    .with(Height::increase(10))
    .to_string();

assert_eq!(
    table,
    "+---------------------+------+------------+\n\
     | &str                | &str | &str       |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data           | here | and here   |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+\n\
     | Some data on a next | line | right here |\n\
     |                     |      |            |\n\
     +---------------------+------+------------+",
)

Source

pub fn limit<W: Measurement<Height>>(height: W) -> CellHeightLimit<W>

Create CellHeightLimit to set a table/cell height.

§Example

§Cell height

use tabled::{Table, settings::{Height, Modify, object::Columns}};

let data = vec![
    ("Some\ndata", "here", "and here"),
    ("Some\ndata on a next", "line", "right here"),
];

let table = Table::new(data)
    .with(Modify::new(Columns::first()).with(Height::limit(1)))
    .to_string();

assert_eq!(
    table,
    "+------+------+------------+\n\
     | &str | &str | &str       |\n\
     +------+------+------------+\n\
     | Some | here | and here   |\n\
     +------+------+------------+\n\
     | Some | line | right here |\n\
     +------+------+------------+"
)

§Table height

use tabled::{Table, settings::Height};

let data = vec![
    ("Some\ndata", "here", "and here"),
    ("Some\ndata on a next", "line", "right here"),
];

let table = Table::new(&data)
    .with(Height::limit(6))
    .to_string();

assert_eq!(
    table,
    "+------+------+------------+\n\
     +------+------+------------+\n\
     | Some | here | and here   |\n\
     +------+------+------------+\n\
     | Some | line | right here |\n\
     +------+------+------------+",
);

let table = Table::new(&data)
    .with(Height::limit(1))
    .to_string();

assert_eq!(
    table,
    "+--+--+--+\n\
     +--+--+--+\n\
     +--+--+--+\n\
     +--+--+--+",
);

Source

pub fn list<I: IntoIterator<Item = usize>>(rows: I) -> HeightList

Create HeightList to set a table height to a constant list of row heights.

Notice if you provide a list with .len() less than Table::count_rows then it will have no affect.

§Example

use tabled::{Table, settings::{Height, Modify, object::Columns}};

let data = vec![
    ("Some\ndata", "here", "and here"),
    ("Some\ndata on a next", "line", "right here"),
];

let table = Table::new(data)
    .with(Height::list([1, 0, 2]))
    .to_string();

assert_eq!(
    table,
    "+----------------+------+------------+\n\
     | &str           | &str | &str       |\n\
     +----------------+------+------------+\n\
     +----------------+------+------------+\n\
     | Some           | line | right here |\n\
     | data on a next |      |            |\n\
     +----------------+------+------------+",
)