Struct Box 

pub struct Box {

    pub top_left: char,
    pub top: char,
    pub top_divider: char,
    pub top_right: char,
    pub head_left: char,
    pub head_vertical: char,
    pub head_right: char,
    pub head_row_left: char,
    pub head_row_horizontal: char,
    pub head_row_cross: char,
    pub head_row_right: char,
    pub mid_left: char,
    pub mid_vertical: char,
    pub mid_right: char,
    pub row_left: char,
    pub row_horizontal: char,
    pub row_cross: char,
    pub row_right: char,
    pub foot_row_left: char,
    pub foot_row_horizontal: char,
    pub foot_row_cross: char,
    pub foot_row_right: char,
    pub foot_left: char,
    pub foot_vertical: char,
    pub foot_right: char,
    pub bottom_left: char,
    pub bottom: char,
    pub bottom_divider: char,
    pub bottom_right: char,
    pub ascii: bool,
}

A complete set of box-drawing characters for creating borders and tables.

The structure contains 32 characters arranged in 8 logical rows:

• top: Top border (corners and dividers)
• head: Header content row (vertical lines)
• head_row: Header separator row
• mid: Mid content row (vertical lines)
• row: Body row separator
• foot_row: Footer separator row
• foot: Footer content row (vertical lines)
• bottom: Bottom border (corners and dividers)

Fields

top_left: char

Top-left corner character.

top: char

Top horizontal line character.

top_divider: char

Top divider (T-junction pointing down).

top_right: char

Top-right corner character.

head_left: char

Left edge of header row.

head_vertical: char

Vertical divider in header.

head_right: char

Right edge of header row.

head_row_left: char

Left edge of head row separator.

head_row_horizontal: char

Horizontal line in head row separator.

head_row_cross: char

Cross junction in head row separator.

head_row_right: char

Right edge of head row separator.

mid_left: char

Left edge of mid content row.

mid_vertical: char

Vertical divider in mid section.

mid_right: char

Right edge of mid content row.

row_left: char

Left edge of row separator.

row_horizontal: char

Horizontal line in row separator.

row_cross: char

Cross junction in row separator.

row_right: char

Right edge of row separator.

foot_row_left: char

Left edge of foot row separator.

foot_row_horizontal: char

Horizontal line in foot row separator.

foot_row_cross: char

Cross junction in foot row separator.

foot_row_right: char

Right edge of foot row separator.

foot_left: char

Left edge of footer row.

foot_vertical: char

Vertical divider in footer.

foot_right: char

Right edge of footer row.

bottom_left: char

Bottom-left corner character.

bottom: char

Bottom horizontal line character.

bottom_divider: char

Bottom divider (T-junction pointing up).

bottom_right: char

Bottom-right corner character.

ascii: bool

Whether this box uses ASCII characters only.

Implementations

impl Box

pub fn substitute(&self, legacy_windows: bool, ascii_only: bool) -> Box

Substitute this box for another if it won’t render due to platform issues.

Arguments

• legacy_windows - If true, substitute boxes that don’t render well with legacy Windows console (raster fonts).
• ascii_only - If true, substitute non-ASCII boxes with ASCII equivalent.

Returns

A compatible Box. For known box constants that need substitution, returns the appropriate fallback. For custom boxes, returns self unchanged unless ascii_only is true and self.ascii is false, in which case returns ASCII.

pub fn get_plain_headed_box(&self) -> Box

If this box uses special characters for the header borders, return the equivalent box without special header characters.

Returns

The equivalent plain-headed Box, or self if already plain. For custom boxes, returns self unchanged.

pub fn get_top(&self, widths: &[usize]) -> String

Generate the top border of a box.

Arguments

• widths - Slice of column widths.

Returns

A string representing the top border.

Example

use rich_rs::r#box::SQUARE;

let top = SQUARE.get_top(&[5, 10, 5]);
assert_eq!(top, "┌─────┬──────────┬─────┐");

pub fn get_row(&self, widths: &[usize], level: RowLevel, edge: bool) -> String

Generate a row separator line.

Arguments

• widths - Slice of column widths.
• level - The type of row separator (Head, Row, Foot, or Mid).
• edge - Whether to include edge characters (left and right borders).

Returns

A string representing the row separator.

Example

use rich_rs::r#box::{SQUARE, RowLevel};

let row = SQUARE.get_row(&[5, 10], RowLevel::Head, true);
assert_eq!(row, "├─────┼──────────┤");

pub fn get_bottom(&self, widths: &[usize]) -> String

Generate the bottom border of a box.

Arguments

• widths - Slice of column widths.

Returns

A string representing the bottom border.

Example

use rich_rs::r#box::SQUARE;

let bottom = SQUARE.get_bottom(&[5, 10, 5]);
assert_eq!(bottom, "└─────┴──────────┴─────┘");

pub fn top_edge(&self, width: usize) -> String

Get a string for the top edge of a simple box (single column).

This is a convenience method for backward compatibility with the original BoxChars implementation.

Arguments

• width - The width of the box interior.

Returns

A string representing the top edge.

pub fn bottom_edge(&self, width: usize) -> String

Get a string for the bottom edge of a simple box (single column).

This is a convenience method for backward compatibility with the original BoxChars implementation.

Arguments

• width - The width of the box interior.

Returns

A string representing the bottom edge.

Trait Implementations

impl Clone for Box

fn clone(&self) -> Box

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Box

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

Formats the value using the given formatter.

impl PartialEq for Box

fn eq(&self, other: &Box) -> 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 Copy for Box

impl Eq for Box

impl StructuralPartialEq for Box