Struct Block 

pub struct Block { /* private fields */ }

Represents a block, i.e. a rectangle, of some width and height containing text.

The key feature of a Block is that it enables you to easily specify how chunks of text should be positioned in relation to other block, by joining blocks together, either vertically or horizontally, and using paddings and fills.

Implementations

impl Block

pub fn empty() -> Self

Create empty block with width and height zero.

pub fn of_width(width: usize) -> Self

Create block of given width and height 0.

pub fn of_height(height: usize) -> Self

Create block of given height and width 0.

pub fn of<T: ToString>(t: T) -> Self

Creates block of any argument implementing std::string::ToString trait, or implicitly by implementing std::fmt::Display. Uses String representation in block. See Block::of_string.

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

👎Deprecated since 1.2.0: please use Block::of instead

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) -> Self

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]) -> Self

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) -> Self

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

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

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

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

Pad right side of block with given number of spaces.

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

Pad left side of block with given number of spaces.

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

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

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

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

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

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

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

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

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) -> Self

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) -> Self

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

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

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

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

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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

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

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

fn clone(&self) -> Block

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Display for Block

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

Formats the value using the given formatter.

impl From<&str> for Block

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Block

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<char> for Block

fn from(c: char) -> Self

Converts to this type from the input type.

impl Hash for Block

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Block

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

impl StructuralPartialEq for Block