Enum ratatui_block::BorderSymbol

pub enum BorderSymbol {
    StartCornerRegular,
    StartCornerAngled(Side, BorderType),
    StartCornerProlonged(Side, BorderType),
    StartCornerCrossed(Side, BorderType, Side, BorderType),
    SideRegular,
    SideOverlap(Side, BorderType),
    SideOutward(Side, BorderType),
    SideInward(Side, BorderType),
    SideCrossed(Side, BorderType, Side, BorderType),
    EndCornerRegular,
    EndCornerAngled(Side, BorderType),
    EndCornerProlonged(Side, BorderType),
    EndCornerCrossed(Side, BorderType, Side, BorderType),
}

Symbol descriptor.

Describes the symbols geometrically as they occur along one side of the area.

Schematics for the connection.

Which side of the other area is connected may also influence the actual glyph.

Construction for PlainBorderSet. Note that some of the glyphs do not exist in unicode and are replaced with single line versions.

Construction for QuadrantInsideBorderSet

Variants

StartCornerRegular

Regular start corner.

StartCornerAngled(Side, BorderType)

Start corner with an extension perpendicular to the line.

StartCornerProlonged(Side, BorderType)

Start corner that goes on in the direction of the line.

StartCornerCrossed(Side, BorderType, Side, BorderType)

Crossing at the start. The first value is the border perpendicular to the line, the second goes in the direction of the line.

SideRegular

Regular side.

SideOverlap(Side, BorderType)

Regular side, but overlapping with some other border.

SideOutward(Side, BorderType)

Side with a connection point outwards.

SideInward(Side, BorderType)

Side with a connection point inwards.

SideCrossed(Side, BorderType, Side, BorderType)

Side with a crossing. The first value is the border outwards, the second goes inwards.

EndCornerRegular

Regular end corner.

EndCornerAngled(Side, BorderType)

End corner with an extension perpendicular to the line.

EndCornerProlonged(Side, BorderType)

End corner that goes on in the direction of the line.

EndCornerCrossed(Side, BorderType, Side, BorderType)

Crossing at the end. The first value is the border perpendicular to the line, the second goes in the direction of the line.

Implementations

impl BorderSymbol

pub fn join_outward(&mut self, side: Side, border: BorderType)

Adds an outward connection to the given border.

Replaces any existing outward connection. Changes the BorderSymbol to add an outward connection if possible.

pub fn join_inward(&mut self, side: Side, border: BorderType)

Adds an inward connection to the given border.

Replaces any existing inward connection. Changes the BorderSymbol to add an inward connection if possible.

pub fn overlap(&mut self, side: Side, border: BorderType)

Changes the BorderSymbol to add an overlapping area if possible.

Does nothing if this is not possible for the current symbol.

pub fn prolong(&mut self, side: Side, border: BorderType)

Changes the BorderSymbol to prolong the border along the side.

Does nothing if this is not possible for the current symbol.

Trait Implementations

impl Clone for BorderSymbol

fn clone(&self) -> BorderSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorderSymbol

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

Formats the value using the given formatter.

impl PartialEq for BorderSymbol

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

impl Eq for BorderSymbol

impl StructuralPartialEq for BorderSymbol