Struct bevy_ascii_terminal::prelude::Border

pub struct Border {
    pub top: char,
    pub left: char,
    pub right: char,
    pub bottom: char,
    pub top_left: char,
    pub top_right: char,
    pub bottom_left: char,
    pub bottom_right: char,
    /* private fields */
}

Specifies the style of lines to use along the border of a box.

Fields

top: char

left: char

right: char

bottom: char

top_left: char

top_right: char

bottom_left: char

bottom_right: char

Implementations

impl Border

pub fn single_line() -> Border

A border with single-line glyphs.

pub fn double_line() -> Border

A border with double-line glyphs.

pub fn from_string(box_string: impl AsRef<str>) -> Self

Construct a new Border from the given string.

The format of the string should match the example below. Line returns and spaces will be ignored.

Example

use bevy_ascii_terminal::Border;
let border = Border::from_string(
    "┌─┐
     │ │
     └─┘"
);

pub fn edge_glyph(&self, edge: Edge) -> char

Returns the glyph for a given border edge.

pub fn with_title(self, title: impl Into<AlignedString>) -> Self

pub fn set_title_string(&mut self, title: impl Into<String>)

Trait Implementations

impl Clone for Border

fn clone(&self) -> Border

Returns a copy 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 Default for Border

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Border> for Border

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