Struct Border

pub struct Border {

    pub top: &'static str,
    pub bottom: &'static str,
    pub left: &'static str,
    pub right: &'static str,
    pub top_left: &'static str,
    pub top_right: &'static str,
    pub bottom_left: &'static str,
    pub bottom_right: &'static str,
    pub middle_left: &'static str,
    pub middle_right: &'static str,
    pub middle: &'static str,
    pub middle_top: &'static str,
    pub middle_bottom: &'static str,
}

Defines all the glyphs that make up a box border for terminal user interfaces.

A Border contains all the Unicode characters needed to draw complete box borders, including corners, edges, and junction characters for complex layouts like tables. This struct mirrors the Go Lip Gloss Border type, providing the same visual styling capabilities in Rust.

Examples

use lipgloss::Border;

// Create a custom border using ASCII characters
let custom_border = Border::new(
    "-", "-", "|", "|", "+", "+", "+", "+",
    "+", "+", "+", "+", "+",
);

// Or use one of the predefined borders
let normal = lipgloss::normal_border();
let rounded = lipgloss::rounded_border();

Fields

top: &'static str

Character used for the top edge of the border

bottom: &'static str

Character used for the bottom edge of the border

left: &'static str

Character used for the left edge of the border

right: &'static str

Character used for the right edge of the border

top_left: &'static str

Character used for the top-left corner of the border

top_right: &'static str

Character used for the top-right corner of the border

bottom_left: &'static str

Character used for the bottom-left corner of the border

bottom_right: &'static str

Character used for the bottom-right corner of the border

middle_left: &'static str

Character used for left-side junction points (for table borders)

middle_right: &'static str

Character used for right-side junction points (for table borders)

middle: &'static str

Character used for cross junction points (for table borders)

middle_top: &'static str

Character used for top junction points (for table borders)

middle_bottom: &'static str

Character used for bottom junction points (for table borders)

Implementations

impl Border

pub const fn new( top: &'static str, bottom: &'static str, left: &'static str, right: &'static str, top_left: &'static str, top_right: &'static str, bottom_left: &'static str, bottom_right: &'static str, middle_left: &'static str, middle_right: &'static str, middle: &'static str, middle_top: &'static str, middle_bottom: &'static str, ) -> Self

Creates a new Border with custom characters for all border elements.

This constructor allows you to define a completely custom border style by specifying characters for each part of the border: edges, corners, and junction points for table rendering. All parameters must be &'static str to ensure the border can be used in const contexts and has a static lifetime.

The junction parameters (middle_*) are primarily used for table rendering where borders need to connect at intersection points. For simple box borders, these can be set to the same values as corners or left empty.

Arguments

• top - Character(s) for the top edge
• bottom - Character(s) for the bottom edge
• left - Character(s) for the left edge
• right - Character(s) for the right edge
• top_left - Character(s) for the top-left corner
• top_right - Character(s) for the top-right corner
• bottom_left - Character(s) for the bottom-left corner
• bottom_right - Character(s) for the bottom-right corner
• middle_left - Character(s) for left junction points (table borders)
• middle_right - Character(s) for right junction points (table borders)
• middle - Character(s) for cross junction points (table borders)
• middle_top - Character(s) for top junction points (table borders)
• middle_bottom - Character(s) for bottom junction points (table borders)

Examples

use lipgloss::Border;

// Create a simple ASCII border
let ascii_border = Border::new(
    "-", "-", "|", "|", "+", "+", "+", "+",
    "+", "+", "+", "+", "+",
);

// Create a Unicode box-drawing border
let unicode_border = Border::new(
    "─", "─", "│", "│", "┌", "┐", "└", "┘",
    "├", "┤", "┼", "┬", "┴",
);

// Create a decorative border with multi-character components
let decorative = Border::new(
    "═══", "═══", "║", "║", "╔", "╗", "╚", "╝",
    "╠", "╣", "╬", "╦", "╩",
);

pub fn get_top_size(&self) -> usize

Returns the maximum character width of the top edge components.

This method calculates the visual width needed for the top edge of the border by finding the maximum width among the top-left corner, top edge, and top-right corner characters. This is important for proper alignment when working with Unicode characters that may have different display widths.

Returns

The maximum character width in terminal columns needed for the top edge.

Examples

use lipgloss::{normal_border, Border};

let border = normal_border();
assert_eq!(border.get_top_size(), 1);

// Wide Unicode character example
let wide_border = Border::new(
    "太", "-", "|", "|", "+", "+", "+", "+",
    "+", "+", "+", "+", "+",
);
assert!(wide_border.get_top_size() >= 2);

pub fn get_right_size(&self) -> usize

Returns the maximum character width of the right edge components.

This method calculates the visual width needed for the right edge of the border by finding the maximum width among the top-right corner, right edge, and bottom-right corner characters.

Returns

The maximum character width in terminal columns needed for the right edge.

Examples

use lipgloss::normal_border;

let border = normal_border();
assert_eq!(border.get_right_size(), 1);

pub fn get_bottom_size(&self) -> usize

Returns the maximum character width of the bottom edge components.

This method calculates the visual width needed for the bottom edge of the border by finding the maximum width among the bottom-left corner, bottom edge, and bottom-right corner characters.

Returns

The maximum character width in terminal columns needed for the bottom edge.

Examples

use lipgloss::normal_border;

let border = normal_border();
assert_eq!(border.get_bottom_size(), 1);

pub fn get_left_size(&self) -> usize

Returns the maximum character width of the left edge components.

This method calculates the visual width needed for the left edge of the border by finding the maximum width among the top-left corner, left edge, and bottom-left corner characters.

Returns

The maximum character width in terminal columns needed for the left edge.

Examples

use lipgloss::normal_border;

let border = normal_border();
assert_eq!(border.get_left_size(), 1);

Trait Implementations

impl Clone for Border

fn clone(&self) -> Border

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Border

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

Formats the value using the given formatter.

impl PartialEq for Border

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

impl Eq for Border

impl StructuralPartialEq for Border