Struct text_block_layout::Block

pub struct Block { /* fields omitted */ }

Represents a block of some width an height containing text.

Implementations

impl Block

pub fn empty() -> Block

Create empty block with width and height zero

pub fn of_width(width: usize) -> Block

Create block of given width and height 0.

pub fn of_height(height: usize) -> Block

Create block of given height and width 0.

pub fn of_text(text: &str) -> Block

Create block containing given text. Gets width of the text and height 1.

pub fn height(&self) -> usize

Return height of block.

pub fn width(&self) -> usize

Return width of block.

pub fn add_text(&self, text: &str) -> Block

Add given text at bottom of block, incementing the height. Width of block will be increased if needed for added line to fit.

pub fn add_multiple_texts(&self, texts: &[String]) -> Block

Add given text lines at bottom of block, incrementing the height accordingly. Width of block will be increades if needed.

pub fn fill_right(&self, width: usize, filler: char) -> Block

Fill right side of block with given number of the filler character.

pub fn fill_bottom(&self, height: usize, filler: char) -> Block

Fill bottom side of block with given number of the filler character.

pub fn pad_right(&self, width: usize) -> Block

Pad right side of block with given number of spaces.

pub fn pad_left(&self, width: usize) -> Block

Pad left side of block with given number of spaces.

pub fn pad_top(&self, height: usize) -> Block

pub fn pad_bottom(&self, height: usize) -> Block

Pad bottom side of block with given number of empty lines.

pub fn pad_to_width_right(&self, width: usize) -> Block

Pad right so given width is reached. Wider block is untouched.

pub fn pad_to_width_left(&self, width: usize) -> Block

Pad left so given width is reached. Wider block is untouched.

pub fn pad_to_width_center_right(&self, width: usize) -> Block

Pad both sides so given width is reached. Wider block is untouched. If padding needs to be uneven, there will be more padding on the right side.

pub fn pad_to_width_center_left(&self, width: usize) -> Block

Pad both sides so given width is reached. Wider block is untouched. If padding needs to be uneven, there will be more padding on the left side.

pub fn pad_to_height_top(&self, height: usize) -> Block

Pad top so given height is reached. Higher block is untouched.

pub fn pad_to_height_bottom(&self, height: usize) -> Block

Pad bottom so given height is reached. Higher block is untouched.

pub fn pad_to_height_center_top(&self, height: usize) -> Block

Pad both top and bottom so given height is reached. Higher block is untouched. If padding needs to be uneven, there will be more padding on the top side.

pub fn pad_to_height_center_bottom(&self, height: usize) -> Block

Pad both top and bottom so given height is reached. Higher block is untouched. If padding needs to be uneven, there will be more padding on the bottom side.

pub fn beside_top(&self, right: &Block) -> Block

Join two blocks horizontally, self to the left and the given block to the right, aligning the top side of the blocks.

pub fn beside_bottom(&self, right: &Block) -> Block

Join two blocks horizontally, self to the left and the given block to the right, aligning the bottom side of the blocks.

pub fn beside_center_bottom(&self, right: &Block) -> Block

Join two blocks horizontally, self to the left and the given block to the right, aligning the center of the blocks. If padding needs to be uneven, there will be more padding on the top side.

pub fn beside_center_top(&self, right: &Block) -> Block

Join two blocks horizontally, self to the left and the given block to the right, aligning the center of the blocks. If padding needs to be uneven, there will be more padding on the bottom side.

pub fn stack_right(&self, bottom: &Block) -> Block

Join two blocks vertically, self on the top and the given block on the bottom, aligning the right side of the blocks.

pub fn stack_left(&self, bottom: &Block) -> Block

Join two blocks vertically, self on the top and the given block on the bottom, aligning the left side of the blocks.

pub fn stack_center_left(&self, bottom: &Block) -> Block

Join two blocks vertically, self on the top and the given block on the bottom, aligning the center of the blocks. If padding needs to be uneven, there will be more padding on the right side.

pub fn stack_center_right(&self, bottom: &Block) -> Block

Join two blocks vertically, self on the top and the given block on the bottom, aligning the center of the blocks. If padding needs to be uneven, there will be more padding on the left side.

pub fn in_front_of(&self, behind: &Block) -> Block

Overlays self in front of given block. Treats spaces as transparent characters.

pub fn in_front_of_with_transparency(
    &self,
    behind: &Block,
    transparency: char
) -> Block

Overlays self in front of given block, showing content of the block behind on the characters defined as transparent.

pub fn render(&self) -> String

Render a string from a block using '\n' as separator between lines. Trims away whitespace on the right side of each line, just to save on final string length.

Trait Implementations

impl Clone for Block

pub fn clone(&self) -> Block

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Eq for Block

impl From<&'_ str> for Block

pub fn from(text: &str) -> Self

Performs the conversion.

impl From<String> for Block

pub fn from(text: String) -> Self

Performs the conversion.

impl From<char> for Block

pub fn from(text: char) -> Self

Performs the conversion.

impl Hash for Block

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Block> for Block

pub fn eq(&self, other: &Block) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Block) -> bool

This method tests for !=.

impl StructuralEq for Block

impl StructuralPartialEq for Block

impl ToString for Block

pub fn to_string(&self) -> String

Converts the given value to a String.