Struct Rule 

pub struct Rule<'a> { /* private fields */ }

A horizontal rule / divider.

Renders a single-row horizontal line using a border character, optionally with a title inset at the given alignment.

Examples

use ftui_widgets::rule::Rule;
use ftui_widgets::block::Alignment;

// Simple divider
let rule = Rule::new();

// Titled divider, centered
let rule = Rule::new()
    .title("Section")
    .title_alignment(Alignment::Center);

Implementations

impl<'a> Rule<'a>

pub fn new() -> Self

Create a new rule with default settings (square horizontal line, no title).

pub fn title(self, title: &'a str) -> Self

Set the title text.

pub fn title_alignment(self, alignment: Alignment) -> Self

Set the title alignment.

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

Set the style for the rule line.

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

Set a separate style for the title text.

If not set, the rule’s main style is used for the title.

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

Set the border type (determines the line character).

Trait Implementations

impl<'a> Clone for Rule<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Rule<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Rule<'a>

fn default() -> Self

Returns the “default value” for a type.

impl MeasurableWidget for Rule<'_>

fn measure(&self, _available: Size) -> SizeConstraints

Measure the widget given available space.

fn has_intrinsic_size(&self) -> bool

Quick check: does this widget have content-dependent sizing?

impl<'a> PartialEq for Rule<'a>

fn eq(&self, other: &Rule<'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 Widget for Rule<'_>

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.

impl<'a> Eq for Rule<'a>

impl<'a> StructuralPartialEq for Rule<'a>