Skip to main content

BorderType

Enum BorderType 

Source
pub enum BorderType {
    Plain,
    Rounded,
    Double,
    Thick,
}
Expand description

The box-drawing glyph set BoxBorder, Panel, and Modal draw their corners and edges with.

BorderType::Plain is the default: the single-line set every one of these widgets drew before this type existed, so adding it is purely additive. The other three variants exist to make nested or stateful boxes visually distinct at a glance: an outer BorderType::Double around an inner BorderType::Plain reads instantly, where two identical single lines don’t, and double/thick borders are a legible way to mark an active pane even on a 16-color terminal where Theme alone can’t carry that distinction.

Covers four of ratatui’s six BorderType variants (Plain, Rounded, Double, Thick); QuadrantInside/QuadrantOutside are omitted since nothing here has a use for them yet. Each variant maps directly to a BorderSet in retroglyph_core::symbols::border, the shared glyph tables every crate draws borders from.

§Examples

use retroglyph_ui::{BorderType, BoxBorder};

let border = BoxBorder::new().border_type(BorderType::Rounded);

Variants§

§

Plain

Single-line box-drawing glyphs: ┌─┐│└┘.

§

Rounded

Single-line glyphs with rounded corners: ╭─╮│╰╯.

§

Double

Double-line box-drawing glyphs: ╔═╗║╚╝.

§

Thick

Heavy single-line box-drawing glyphs: ┏━┓┃┗┛.

Trait Implementations§

Source§

impl Clone for BorderType

Source§

fn clone(&self) -> BorderType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BorderType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BorderType

Source§

fn default() -> BorderType

Returns the “default value” for a type. Read more
Source§

impl Hash for BorderType

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BorderType

Source§

fn eq(&self, other: &BorderType) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for BorderType

Source§

impl Eq for BorderType

Source§

impl StructuralPartialEq for BorderType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<C> WithAlpha for C
where C: Copy,

§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see [AlphaFirst]).
§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see [AlphaLast]).