Struct papergrid::config::Border

pub struct Border<T> {
    pub top: Option<T>,
    pub bottom: Option<T>,
    pub left: Option<T>,
    pub right: Option<T>,
    pub left_top_corner: Option<T>,
    pub left_bottom_corner: Option<T>,
    pub right_top_corner: Option<T>,
    pub right_bottom_corner: Option<T>,
}

Border is a representation of a cells’s borders (left, right, top, bottom, and the corners)

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

Fields

top: Option<T>

A character for a top.

bottom: Option<T>

A character for a bottom.

left: Option<T>

A character for a left.

right: Option<T>

A character for a right.

left_top_corner: Option<T>

A character for a left top corner.

left_bottom_corner: Option<T>

A character for a left bottom corner.

right_top_corner: Option<T>

A character for a right top corner.

right_bottom_corner: Option<T>

A character for a right bottom corner.

Implementations

impl<T> Border<T>

pub const fn new( top: Option<T>, bottom: Option<T>, left: Option<T>, right: Option<T>, left_top_corner: Option<T>, left_bottom_corner: Option<T>, right_top_corner: Option<T>, right_bottom_corner: Option<T>, ) -> Self

This function constructs a cell borders with all sides set.

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

This function constructs a cell borders with all sides set.

pub const fn empty() -> Self

This function constructs a cell borders with all sides being empty (set off).

pub const fn is_empty(&self) -> bool

Checks whether any side is set.

pub const fn has_top(&self) -> bool

Verifies whether anything is set on the top.

pub const fn has_bottom(&self) -> bool

Verifies whether anything is set on the bottom.

pub const fn has_left(&self) -> bool

Verifies whether anything is set on the left.

pub const fn has_right(&self) -> bool

Verifies whether anything is set on the right.

impl<T: Copy> Border<T>

pub fn filled(c: T) -> 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.

impl<T: Copy> Border<&T>

pub fn copied(&self) -> Border<T>

Copies the underlying reference to a new border.

impl<T: Clone> Border<&T>

pub fn cloned(&self) -> Border<T>

Copies the underlying reference to a new border.

impl<T> Border<T>

pub fn convert<B>(self) -> Border<B>

where B: From<T>,

Convert all values on the border into another ones.

Trait Implementations

impl<T: Clone> Clone for Border<T>

fn clone(&self) -> Border<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Border<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Border<T>

fn default() -> Border<T>

Returns the “default value” for a type.

impl<T: Ord> Ord for Border<T>

fn cmp(&self, other: &Border<T>) -> 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<T: PartialEq> PartialEq for Border<T>

fn eq(&self, other: &Border<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for Border<T>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Copy> Copy for Border<T>

impl<T: Eq> Eq for Border<T>

impl<T> StructuralPartialEq for Border<T>