Struct BlockTitle 

pub struct BlockTitle { /* private fields */ }

One styled line embedded in a block’s top border.

A title is content owned by a block, not part of its BlockStyle. Its text carries complete styles, and its alignment and padding apply only within the top edge between enabled side borders.

use urushi::{Align, BlockTitle, Color, StyledText, TextSpan, TextStyle};

let title = StyledText::try_from_spans([
    TextSpan::new("F", TextStyle::new().foreground(Color::CYAN)),
    TextSpan::from("iles"),
])
.unwrap();
let title = BlockTitle::new(title).align(Align::Center).padding(0);

assert_eq!(title.text().as_str(), "Files");

Implementations

impl BlockTitle

pub fn new(text: impl Into<StyledText>) -> Self

Creates a left-aligned title with one blank cell on each side.

Panics

Panics when text contains a line break. A border title occupies exactly one row and never wraps.

pub const fn align(self, align: Align) -> Self

Sets the title’s alignment between the block’s enabled side borders.

pub const fn padding(self, padding: u16) -> Self

Sets the preferred blank cells on both sides of the title.

A narrow border gives space to title text before this padding.

pub const fn text(&self) -> &StyledText

Returns the title’s single styled line.

pub const fn alignment(&self) -> Align

Returns the title’s alignment between enabled side borders.

pub const fn horizontal_padding(&self) -> u16

Returns the preferred blank cells on both sides of the title.

Trait Implementations

impl Clone for BlockTitle

fn clone(&self) -> BlockTitle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockTitle

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

Formats the value using the given formatter.

impl From<&str> for BlockTitle

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for BlockTitle

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<StyledText> for BlockTitle

fn from(text: StyledText) -> Self

Converts to this type from the input type.

impl PartialEq for BlockTitle

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

impl StructuralPartialEq for BlockTitle