Struct tabled::settings::style::BorderColor

pub struct BorderColor { /* private fields */ }

Available on crate feature std only.

Border represents a border color of a Cell.

                        top border
                            |
                            V
corner top left ------> +_______+  <---- corner top left
                        |       |
left border ----------> |  cell |  <---- right border
                        |       |
corner bottom right --> +_______+  <---- corner bottom right
                            ^
                            |
                       bottom border

Example

let table = Table::new(&data)
    .with(Style::ascii())
    .modify(Rows::single(0), BorderColor::new().top(Color::FG_RED));

Implementations

impl BorderColor

pub const fn new() -> Self

Creates an empty border.

pub const fn full( top: Color, bottom: Color, left: Color, right: Color, top_left: Color, top_right: Color, bottom_left: Color, bottom_right: Color, ) -> Self

This function constructs a cell borders with all sides set.

pub fn filled(c: Color) -> Self

This function constructs a cell borders with all sides’s char set to a given color. It behaves like BorderColor::full with the same color set to each side.

pub fn top(self, c: Color) -> Self

Set a top border color.

pub fn bottom(self, c: Color) -> Self

Set a bottom border color.

pub fn left(self, c: Color) -> Self

Set a left border color.

pub fn right(self, c: Color) -> Self

Set a right border color.

pub fn into_inner(self) -> GridBorder<Color>

Converts a border into a general data structure.

pub fn corner_top_left(self, c: Color) -> Self

Set a top left intersection color.

pub fn corner_top_right(self, c: Color) -> Self

Set a top right intersection color.

pub fn corner_bottom_left(self, c: Color) -> Self

Set a bottom left intersection color.

pub fn corner_bottom_right(self, c: Color) -> Self

Set a bottom right intersection color.

Trait Implementations

impl<Data> CellOption<Data, ColoredConfig> for BorderColor

where Data: Records + ExactRecords,

fn change(self, records: &mut Data, cfg: &mut ColoredConfig, entity: Entity)

Modification function of a certail part of a grid targeted by Entity.

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

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

impl Clone for BorderColor

fn clone(&self) -> BorderColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorderColor

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

Formats the value using the given formatter.

impl Default for BorderColor

fn default() -> BorderColor

Returns the “default value” for a type.

impl From<BorderColor> for Border<Color>

fn from(value: BorderColor) -> Self

Converts to this type from the input type.

impl Ord for BorderColor

fn cmp(&self, other: &BorderColor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for BorderColor

fn eq(&self, other: &BorderColor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BorderColor

fn partial_cmp(&self, other: &BorderColor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Data, D> TableOption<Data, ColoredConfig, D> for BorderColor

where Data: Records + ExactRecords,

fn change(self, records: &mut Data, 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.

impl Eq for BorderColor

impl StructuralPartialEq for BorderColor