Struct ColumnNames

pub struct ColumnNames { /* private fields */ }

ColumnNames sets strings on horizontal lines for the columns.

Notice that using a Default would reuse a names from the first row.

Examples

use std::iter::FromIterator;
use tabled::{
    Table,
    settings::{themes::ColumnNames, Alignment},
};

let data = vec![
    vec!["Hello", "World"],
    vec!["Hello", "World"],
];

let mut table = Table::from_iter(data);
table.with(
    ColumnNames::new(["head1", "head2"])
        .line(2)
        .alignment(Alignment::right())
);

assert_eq!(
    table.to_string(),
    "+-------+-------+\n\
     | Hello | World |\n\
     +-------+-------+\n\
     | Hello | World |\n\
     +--head1+--head2+"
);

Default usage.

use std::iter::FromIterator;
use tabled::{Table, settings::themes::ColumnNames};

let data = vec![
    vec!["Hello", "World"],
    vec!["Hello", "World"],
];

let mut table = Table::from_iter(data);
table.with(ColumnNames::head());

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

Implementations

impl ColumnNames

pub fn head() -> Self

Creates a ColumnNames which will be removing the head row and putting it right on the given border.

Example

use std::iter::FromIterator;
use tabled::{Table, settings::themes::ColumnNames, assert::assert_table};

let data = vec![
    vec!["head1", "head2"],
    vec!["Hello", "World"],
];

let mut table = Table::from_iter(data);
table.with(ColumnNames::head());

assert_table!(
    table,
    "+head1--+head2--+"
    "| Hello | World |"
    "+-------+-------+"
);

pub fn new<I>(names: I) -> Self

where I: IntoIterator, I::Item: Into<String>,

Creates a ColumnNames with a given names.

Using a Default would reuse a names from the first row.

Example

use std::iter::FromIterator;
use tabled::{Table, settings::themes::ColumnNames, assert::assert_table};

let data = vec![vec!["Hello", "World"]];
let mut table = Table::from_iter(data);
table.with(ColumnNames::new(["head1", "head2"]));

assert_table!(
    table,
    "+head1--+head2--+"
    "| Hello | World |"
    "+-------+-------+"
);

pub fn color<T>(self, color: T) -> Self

where T: Into<ListValue<Color>>,

Set color for the column names.

By default there’s no colors.

Example

use std::iter::FromIterator;
use tabled::Table;
use tabled::settings::{Color, themes::ColumnNames};
use tabled::assert::assert_table;

let data = vec![vec!["Hello", "World"]];
let mut table = Table::from_iter(data);
table.with(ColumnNames::new(["head1", "head2"]).color(vec![Color::FG_RED]));

assert_table!(
    table,
    "+\u{1b}[31mh\u{1b}[39m\u{1b}[31me\u{1b}[39m\u{1b}[31ma\u{1b}[39m\u{1b}[31md\u{1b}[39m\u{1b}[31m1\u{1b}[39m--+head2--+"
    "| Hello | World |"
    "+-------+-------+"
);

pub fn line(self, i: usize) -> Self

Set a horizontal line the names will be applied to.

The default value is 0 (the top horizontal line).

Example

use std::iter::FromIterator;
use tabled::{Table, settings::themes::ColumnNames};

let mut table = Table::from_iter(vec![vec!["Hello", "World"]]);
table.with(ColumnNames::new(["head1", "head2"]).line(1));

assert_eq!(
    table.to_string(),
    "+-------+-------+\n\
     | Hello | World |\n\
     +head1--+head2--+"
);

pub fn alignment<T>(self, alignment: T) -> Self

where T: Into<ListValue<Alignment>>,

Set an alignment for the names.

By default it’s left aligned.

Example

use std::iter::FromIterator;
use tabled::{
    Table,
    settings::{themes::ColumnNames, Alignment},
};

let mut table = Table::from_iter(vec![vec!["Hello", "World"]]);
table.with(ColumnNames::new(["head1", "head2"]).alignment(Alignment::right()));

assert_eq!(
    table.to_string(),
    "+--head1+--head2+\n\
     | Hello | World |\n\
     +-------+-------+"
);

Trait Implementations

impl Clone for ColumnNames

fn clone(&self) -> ColumnNames

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnNames

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

Formats the value using the given formatter.

impl TableOption<VecRecords<Text<String>>, ColoredConfig, CompleteDimension> for ColumnNames

fn change( self, records: &mut VecRecords<Text<String>>, cfg: &mut ColoredConfig, dims: &mut CompleteDimension, )

The function modificaties of records and a grid configuration.

fn hint_change(&self) -> Option<Entity>

A hint whether an TableOption is going to change table layout.