Struct BlockStyle 

pub struct BlockStyle { /* private fields */ }

A rectangle: padding, margin, border, dimensions, alignment, and the TextStyle that fills the geometry they create.

A BlockStyle is an immutable value, like TextStyle. Its text properties — colors and attributes — are the style of the block’s own fill: padding rows, alignment gaps, and text explicitly built from BlockStyle::text_style. A block’s style does not flow into a child view; each child carries its own complete value.

use urushi::{BlockStyle, Border, TextStyle, View};

let panel = BlockStyle::new().border(Border::ROUNDED).padding((0, 1));
let view = View::block(panel, View::text("こんにちは, urushi!", TextStyle::new()));

Implementations

impl BlockStyle

pub fn new() -> Self

pub fn from_text_style(text_style: TextStyle) -> Self

Creates a block style filled with text.

pub const fn text_style(&self) -> &TextStyle

Returns the style filling this block.

pub fn foreground(self, color: impl Into<Color>) -> Self

Sets the fill (and text) foreground color.

pub fn reset_foreground(self) -> Self

Returns the fill foreground color to the terminal default.

pub fn background(self, color: impl Into<Color>) -> Self

Sets the fill (and text) background color.

pub fn reset_background(self) -> Self

Returns the fill background color to the terminal default.

pub fn add_attribute(self, attribute: TextAttribute) -> Self

Adds one active fill text attribute.

pub fn add_attributes(self, attributes: TextAttributes) -> Self

Adds a set of active fill text attributes.

pub fn remove_attribute(self, attribute: TextAttribute) -> Self

Removes one active fill text attribute.

pub fn remove_attributes(self, attributes: TextAttributes) -> Self

Removes a set of active fill text attributes.

pub fn reset_attributes(self) -> Self

Restores the active fill text attributes to their default value.

pub fn bold(self) -> Self

pub fn dim(self) -> Self

pub fn italic(self) -> Self

pub fn underlined(self) -> Self

Underlines the fill text with a single line in the foreground color.

pub fn underline_style(self, style: UnderlineStyle) -> Self

Sets the shape the fill text’s underline is drawn with, adding an underline in the foreground color when the style has none.

pub fn underline_color(self, color: impl Into<Color>) -> Self

Sets the color the fill text’s underline is drawn in, adding a single underline when the style has none.

pub fn underline(self, underline: Underline) -> Self

Replaces the complete fill text underline value.

pub fn reset_underline(self) -> Self

Removes the fill text underline, including its color.

pub fn hyperlink(self, hyperlink: impl Into<Hyperlink>) -> Self

Attaches an OSC 8 hyperlink to the fill text.

pub fn reset_hyperlink(self) -> Self

Removes the OSC 8 hyperlink from the fill text.

pub fn blink(self) -> Self

pub fn reverse(self) -> Self

pub fn hide(self) -> Self

pub fn strikethrough(self) -> Self

pub fn padding(self, sides: impl Into<Sides>) -> Self

Sets padding between the content and the border.

pub fn reset_padding(self) -> Self

Restores the block padding to its default value.

pub fn margin(self, sides: impl Into<Sides>) -> Self

Sets unstyled spacing outside the border.

pub fn reset_margin(self) -> Self

Restores the block margin to its default value.

pub fn border(self, border: Border) -> Self

Sets the border glyphs around the padded content.

A new style enables all four edges. Use the border_* builders to configure edge visibility independently.

pub fn reset_border(self) -> Self

Removes the border glyph set. Edge configuration is retained.

pub fn border_top(self, enabled: bool) -> Self

Enables or disables the top border edge.

pub fn reset_border_top(self) -> Self

Restores top-edge visibility to its default value.

pub fn border_right(self, enabled: bool) -> Self

Enables or disables the right border edge.

pub fn reset_border_right(self) -> Self

Restores right-edge visibility to its default value.

pub fn border_bottom(self, enabled: bool) -> Self

Enables or disables the bottom border edge.

pub fn reset_border_bottom(self) -> Self

Restores bottom-edge visibility to its default value.

pub fn border_left(self, enabled: bool) -> Self

Enables or disables the left border edge.

pub fn reset_border_left(self) -> Self

Restores left-edge visibility to its default value.

pub fn border_text_style(self, style: TextStyle) -> Self

Replaces the complete logical style used for border glyphs.

A subsequently applied border foreground or background overrides the corresponding property in this style.

pub fn reset_border_text_style(self) -> Self

Restores the complete logical border-glyph style to its default value.

pub fn border_foreground(self, color: impl Into<Color>) -> Self

Sets the border foreground color.

pub fn reset_border_foreground(self) -> Self

Removes the border foreground override.

pub fn border_background(self, color: impl Into<Color>) -> Self

Sets the border background color.

pub fn reset_border_background(self) -> Self

Removes the border background override.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the box: content plus padding plus enabled border edges, with margin outside it.

The absence of a width means auto — the content’s own width. Content wider than the resolved box is absorbed by BlockStyle::overflow; the frame closes at the resolved width either way.

pub fn reset_width(self) -> Self

Returns the width to auto sizing.

pub fn height(self, height: impl Into<Length>) -> Self

Sets the height of the box: content plus padding plus enabled border edges, with margin outside it.

This is a size, not a minimum: taller content is clipped inside the frame rather than growing the box. The absence of a height means auto.

pub fn reset_height(self) -> Self

Returns the height to auto sizing.

pub fn min_width(self, width: u16) -> Self

Sets the width below which the box does not shrink.

pub fn reset_min_width(self) -> Self

Removes the minimum width.

pub fn min_height(self, height: u16) -> Self

Sets the height below which the box does not shrink.

pub fn reset_min_height(self) -> Self

Removes the minimum height.

pub fn max_width(self, width: u16) -> Self

Bounds the box’s width. The box shrinks to fit its content and never exceeds this bound; the bound never cuts the frame.

pub fn reset_max_width(self) -> Self

Removes the maximum width.

pub fn max_height(self, height: u16) -> Self

Bounds the box’s height. The box shrinks to fit its content and never exceeds this bound; the bound never cuts the frame.

pub fn reset_max_height(self) -> Self

Removes the maximum height.

pub fn overflow(self, overflow: Overflow) -> Self

Sets how content wider than the box is absorbed.

pub fn reset_overflow(self) -> Self

Restores the overflow policy to its default value.

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

Sets the horizontal alignment of content within the box.

pub fn reset_align(self) -> Self

Restores horizontal alignment to its default value.

pub fn vertical_align(self, align: VerticalAlign) -> Self

Sets the vertical alignment of content within a fixed-height box.

pub fn reset_vertical_align(self) -> Self

Restores vertical alignment to its default value.

pub const fn get_foreground(&self) -> Option<Color>

Returns the fill foreground color instruction, if one is set.

pub const fn get_background(&self) -> Option<Color>

Returns the fill background color instruction, if one is set.

pub const fn get_underline(&self) -> Option<Underline>

Returns the fill text’s underline instruction, if one is set.

pub const fn get_attributes(&self) -> TextAttributes

Returns the active fill text attributes.

pub const fn get_padding(&self) -> Sides

Returns the padding applied inside the border.

pub const fn get_margin(&self) -> Sides

Returns the unstyled margin applied outside the border.

pub const fn get_border(&self) -> Option<Border>

Returns the border glyph set, if a border is enabled.

pub const fn get_border_top(&self) -> bool

Returns whether the top border edge is enabled.

pub const fn get_border_right(&self) -> bool

Returns whether the right border edge is enabled.

pub const fn get_border_bottom(&self) -> bool

Returns whether the bottom border edge is enabled.

pub const fn get_border_left(&self) -> bool

Returns whether the left border edge is enabled.

pub const fn get_border_text_style(&self) -> &TextStyle

Returns the complete logical style used as the border-style base.

pub const fn get_border_foreground(&self) -> Option<Color>

Returns the border foreground color instruction.

pub const fn get_border_background(&self) -> Option<Color>

Returns the border background color instruction.

pub const fn get_width(&self) -> Option<Length>

Returns the box’s width, if one is set.

pub const fn get_height(&self) -> Option<Length>

Returns the box’s height, if one is set.

pub const fn get_min_width(&self) -> Option<u16>

Returns the box’s minimum width, if one is set.

pub const fn get_min_height(&self) -> Option<u16>

Returns the box’s minimum height, if one is set.

pub const fn get_max_width(&self) -> Option<u16>

Returns the box’s maximum width, if one is set.

pub const fn get_max_height(&self) -> Option<u16>

Returns the box’s maximum height, if one is set.

pub const fn get_overflow(&self) -> &Overflow

Returns how content wider than the box is absorbed.

pub fn frame_size(&self) -> Size

Returns the per-axis overhead of enabled border edges plus padding.

This is the conversion between the box a dimension measures and the content area inside it: outer minus frame_size() is the content area. Margin lies outside the box and keeps BlockStyle::get_margin.

pub const fn get_align(&self) -> Align

Returns the horizontal alignment within the content box.

pub const fn get_vertical_align(&self) -> VerticalAlign

Returns the vertical alignment within the content box.

Trait Implementations

impl Clone for BlockStyle

fn clone(&self) -> BlockStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockStyle

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

Formats the value using the given formatter.

impl Default for BlockStyle

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BlockStyle

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

impl StructuralPartialEq for BlockStyle