Struct ratatui_block::block_border::BlockBorder

pub struct BlockBorder { /* private fields */ }

Border for a Block.

Borders are rendered as four lines along the sides. Be aware that the corners are thrown in with the top/bottom lines.

The BorderSymbolSet maps geometrical positions along the lines to the actual glyphs used.

Implementations

impl BlockBorder

pub fn new() -> Self

Create a block border without any restrictions.

pub fn from_layout( areas: &[Rect], borders: &[BorderType], select: usize, ) -> Self

New block border for a Block that is part of some bigger layout.

Given all the areas of the layout and each border type, this creates a border that is connected at the edges.

The resulting border can only be rendered for an area of the same size.

pub fn border_style(self, style: Style) -> Self

Border style for the border.

pub fn border_type(self, border: BorderType) -> Self

Sets the border type used.

pub fn border_set(self, border_set: Box<dyn BorderSymbolSet>) -> Self

Use a BorderSymbolSet.

pub fn get_symbol(&self, area: Rect, position: Position) -> BorderSymbol

Return the symbol at the given position along the border.

When using the returned BorderSymbol you must be aware, that the corners are rendered with the top and bottom lines.

x

Panic

Panics if the dimensions of the area don’t match a prefabricated border. Panics if the given position doesn’t lie on the border.

Trait Implementations

impl Clone for BlockBorder

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockBorder

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

Formats the value using the given formatter.

impl Default for BlockBorder

fn default() -> Self

Returns the “default value” for a type.

impl Widget for &BlockBorder

fn render(self, area: Rect, buf: &mut Buffer)

where Self: Sized,

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Widget for BlockBorder

fn render(self, area: Rect, buf: &mut Buffer)

where Self: Sized,

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.