Struct tabled::settings::highlight::Highlight

pub struct Highlight<O> { /* private fields */ }

Available on crate feature std only.

Highlight modifies a table style by changing a border of a target Table segment.

Example

use tabled::{
    Table,
    settings::{Highlight, Border, Style, object::Segment}
};

let data = [
    ("ELF", "Extensible Linking Format", true),
    ("DWARF", "", true),
    ("PE", "Portable Executable", false),
];

let table = Table::new(data.iter().enumerate())
               .with(Style::markdown())
               .with(Highlight::border(Segment::all(), Border::new().set_top('^').set_bottom('v')))
               .to_string();

assert_eq!(
    table,
    concat!(
        " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ \n",
        "| usize | &str  | &str                      | bool  |\n",
        "|-------|-------|---------------------------|-------|\n",
        "| 0     | ELF   | Extensible Linking Format | true  |\n",
        "| 1     | DWARF |                           | true  |\n",
        "| 2     | PE    | Portable Executable       | false |\n",
        " vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv ",
    ),
);

It’s possible to use Highlight for many kinds of figures.

use tabled::{
    Table,
    settings::{
        Highlight, Border, Style,
        object::{Segment, Object}
    }
};

let data = [
    ("ELF", "Extensible Linking Format", true),
    ("DWARF", "", true),
    ("PE", "Portable Executable", false),
];

let table = Table::new(data.iter().enumerate())
               .with(Style::markdown())
               .with(Highlight::border(Segment::all().not((0,0).and((1, 0)).and((0, 1)).and((0, 3))), Border::filled('*')))
               .to_string();

println!("{}", table);

assert_eq!(
    table,
    concat!(
        "                *****************************        \n",
        "| usize | &str  * &str                      * bool  |\n",
        "|-------*********---------------------------*********\n",
        "| 0     * ELF   | Extensible Linking Format | true  *\n",
        "*********                                           *\n",
        "* 1     | DWARF |                           | true  *\n",
        "*                                                   *\n",
        "* 2     | PE    | Portable Executable       | false *\n",
        "*****************************************************",
    ),
);

Implementations

impl<O> Highlight<O>

pub const fn border<T, B, L, R>(target: O, border: Border<T, B, L, R>) -> Self

Build a new instance of Highlight

BE AWARE: if target exceeds boundaries it may panic.

pub fn color<T, B, L, R>(target: O, border: BorderColor<T, B, L, R>) -> Self

Build a new instance of Highlight

BE AWARE: if target exceeds boundaries it may panic.

pub const fn outline(target: O, c: char) -> Self

Build a new instance of Highlight

BE AWARE: if target exceeds boundaries it may panic.

pub fn colored_outline<T, B, L, R>(target: O, c: char, color: Color) -> Self

Build a new instance of Highlight

BE AWARE: if target exceeds boundaries it may panic.

pub fn colored_border<T, B, L, R>( target: O, border: Border<T, B, L, R>, color: BorderColor<T, B, L, R> ) -> Self

Build a new instance of Highlight

BE AWARE: if target exceeds boundaries it may panic.

Trait Implementations

impl<O: Debug> Debug for Highlight<O>

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

Formats the value using the given formatter.

impl<O, R, D> TableOption<R, ColoredConfig, D> for Highlight<O>

where O: Object<R>, R: Records + ExactRecords,

fn change(self, records: &mut R, cfg: &mut ColoredConfig, _: &mut D)

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.