Struct Block 

pub struct Block<'a> {
    pub title: Option<&'a str>,
    pub title_alignment: Alignment,
    pub borders: u8,
    pub border_style: Style,
    pub border_type: BorderType,
    pub style: Style,
}

A bordered container widget with optional title.

Renders a box border around a region with configurable borders, title, and styles.

Examples

use extui::{Block, BorderType, Alignment};

let block = Block {
    title: Some("My Title"),
    borders: Block::ALL,
    ..Default::default()
};

Fields

title: Option<&'a str>

Optional title displayed on the top border.

title_alignment: Alignment

Alignment of the title within the top border.

borders: u8

Bitmask of visible borders (use LEFT, RIGHT, etc.).

border_style: Style

Style applied to border characters.

border_type: BorderType

Type of border characters to use.

style: Style

Style applied to the block background.

Implementations

impl Block<'_>

pub const LEFT: u8 = 0b0001

Left border flag.

pub const RIGHT: u8 = 0b0010

Right border flag.

pub const TOP: u8 = 0b0100

Top border flag.

pub const BOTTOM: u8 = 0b1000

Bottom border flag.

pub const ALL: u8

All borders flag.

impl Block<'_>

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

Renders the block within the given rectangle.

pub fn inner(&self, rect: Rect) -> Rect

Trait Implementations

impl<'a> Clone for Block<'a>

fn clone(&self) -> Block<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Block<'a>

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

Formats the value using the given formatter.

impl Default for Block<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq for Block<'a>

fn eq(&self, other: &Block<'a>) -> 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<'a> Eq for Block<'a>

impl<'a> StructuralPartialEq for Block<'a>