Struct Border

pub struct Border<T, B, L, R> { /* private fields */ }

Border represents a border 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

let mut table = Table::new(&data);
table.with(Style::ascii());
table.modify(Rows::one(0), Border::new().top('x'));

Implementations

impl Border<(), (), (), ()>

pub const fn new() -> Self

Creates an empty border.

impl Border<On, On, On, On>

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

This function constructs a cell borders with all sides set.

pub const fn filled(c: char) -> Self

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

pub const fn empty() -> EmptyBorder

Using this function you deconstruct the existing borders.

impl<T, B, L, R> Border<T, B, L, R>

pub const fn inherit<H, V, const HSIZE: usize, const VSIZE: usize>( style: Style<T, B, L, R, H, V, HSIZE, VSIZE>, ) -> Self

Fetches outer border from a style.

impl<T, B, L, R> Border<T, B, L, R>

pub const fn top(self, c: char) -> Border<On, B, L, R>

Set a top border character.

pub const fn bottom(self, c: char) -> Border<T, On, L, R>

Set a bottom border character.

pub const fn left(self, c: char) -> Border<T, B, On, R>

Set a left border character.

pub const fn right(self, c: char) -> Border<T, B, L, On>

Set a right border character.

pub const fn into_inner(self) -> GridBorder<char>

Converts a border into a general data structure.

impl<T, B, L> Border<T, B, L, On>

pub const fn get_right(&self) -> char

Get a right character.

impl<T, B, R> Border<T, B, On, R>

pub const fn get_left(&self) -> char

Get a left character.

impl<B, L, R> Border<On, B, L, R>

pub const fn get_top(&self) -> char

Get a top character.

impl<T, L, R> Border<T, On, L, R>

pub const fn get_bottom(&self) -> char

Get a bottom character.

impl<B, R> Border<On, B, On, R>

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

Set a top left intersection character.

pub const fn get_corner_top_left(&self) -> char

Get a top left intersection character.

impl<B, L> Border<On, B, L, On>

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

Set a top right intersection character.

pub const fn get_corner_top_right(&self) -> char

Get a top right intersection character.

impl<T, R> Border<T, On, On, R>

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

Set a bottom left intersection character.

pub const fn get_corner_bottom_left(&self) -> char

Get a bottom left intersection character.

impl<T, L> Border<T, On, L, On>

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

Set a bottom right intersection character.

pub const fn get_corner_bottom_right(&self) -> char

Get a bottom left intersection character.

Trait Implementations

impl<T, B, L, R, Data> CellOption<Data, ColoredConfig> for Border<T, B, L, R>

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<T: Clone, B: Clone, L: Clone, R: Clone> Clone for Border<T, B, L, R>

fn clone(&self) -> Border<T, B, L, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, B: Debug, L: Debug, R: Debug> Debug for Border<T, B, L, R>

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

Formats the value using the given formatter.

impl<T: Default, B: Default, L: Default, R: Default> Default for Border<T, B, L, R>

fn default() -> Border<T, B, L, R>

Returns the “default value” for a type.

impl<T, B, L, R> From<Border<T, B, L, R>> for Border<char>

fn from(value: Border<T, B, L, R>) -> Self

Converts to this type from the input type.

impl<T: Ord, B: Ord, L: Ord, R: Ord> Ord for Border<T, B, L, R>

fn cmp(&self, other: &Border<T, B, L, R>) -> 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,

Restrict a value to a certain interval.

impl<T: PartialEq, B: PartialEq, L: PartialEq, R: PartialEq> PartialEq for Border<T, B, L, R>

fn eq(&self, other: &Border<T, B, L, R>) -> 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<T: PartialOrd, B: PartialOrd, L: PartialOrd, R: PartialOrd> PartialOrd for Border<T, B, L, R>

fn partial_cmp(&self, other: &Border<T, B, L, R>) -> 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<T, B, L, R, Data, D> TableOption<Data, ColoredConfig, D> for Border<T, B, L, R>

where Data: Records + ExactRecords,

fn change(self, records: &mut Data, cfg: &mut ColoredConfig, dims: &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<T: Copy, B: Copy, L: Copy, R: Copy> Copy for Border<T, B, L, R>

impl<T: Eq, B: Eq, L: Eq, R: Eq> Eq for Border<T, B, L, R>

impl<T, B, L, R> StructuralPartialEq for Border<T, B, L, R>