Struct Rule 

pub struct Rule {
    pub title: Option<Text>,
    pub characters: String,
    pub style: Style,
    pub end: String,
    pub align: HorizontalAlign,
}

A horizontal rule (line) with optional centered, left-, or right-aligned title.

Fields

title: Option<Text>

Optional title text displayed within the rule.

characters: String

Character(s) used to draw the line.

style: Style

Style for the rule line characters.

end: String

String appended after the rule (default "\n").

align: HorizontalAlign

Alignment of the title within the rule.

Implementations

impl Rule

pub fn new() -> Self

Create a new Rule with defaults: no title, “─” character, rule.line style, newline end, center alignment.

Note: rich defaults to ─ (U+2500, light horizontal). The previous default was ━ (U+2501, heavy); updated for rich parity.

pub fn with_title(title: &str) -> Self

Create a rule with a title string.

pub fn with_characters(self, chars: &str) -> Self

Set the line characters.

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

Set the rule style.

pub fn with_align(self, align: HorizontalAlign) -> Self

Set the alignment.

pub fn with_end(self, end: &str) -> Self

Set the end string.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl Default for Rule

fn default() -> Self

Returns the “default value” for a type.

impl Display for Rule

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

Formats the value using the given formatter.

impl Renderable for Rule

fn gilt_console( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

Produce segments for rendering on the given console with given options.