Struct BoxPad 

pub struct BoxPad {
    pub top: usize,
    pub down: usize,
    pub left: usize,
    pub right: usize,
}

Represents padding values for the text box in all four directions.

BoxPad is used to specify padding between:

• The box border and the contained text (internal padding)
• The terminal edges and the box itself (external padding)

Examples

use boxy_cli::prelude::*;

// Create uniform padding of 2 spaces on all sides
let uniform_padding = BoxPad::uniform(2);

// Create custom padding for each side
let custom_padding = BoxPad::from_tldr(1, 3, 1, 3); // top, left, down, right

// Create horizontal/vertical padding
let h_v_padding = BoxPad::vh(1, 3); // 1 vertical, 3 horizontal

Fields

top: usize

Padding at the top

down: usize

Padding at the bottom

left: usize

Padding on the left side

right: usize

Padding on the right side

Implementations

impl BoxPad

pub fn new() -> Self

Creates a new BoxPad instance with zero padding on all sides.

Examples

use boxy_cli::prelude::*;

let padding = BoxPad::new();
// Equivalent to BoxPad { top: 0, down: 0, left: 0, right: 0 }

pub fn from_tldr(top: usize, left: usize, down: usize, right: usize) -> Self

Creates a new BoxPad with specific values for each side.

The parameter order follows the mnemonic “tldr” (top, left, down, right).

Arguments

• top - Padding at the top
• left - Padding on the left side
• down - Padding at the bottom
• right - Padding on the right side

Examples

use boxy_cli::prelude::*;

// Create padding with different values on each side
let padding = BoxPad::from_tldr(2, 4, 2, 4);
// top: 2, left: 4, down: 2, right: 4

pub fn uniform(pad: usize) -> Self

Creates a new BoxPad with the same padding value on all sides.

Arguments

• pad - The padding value to use for all sides

Examples

use boxy_cli::prelude::*;

// Create uniform padding of 3 spaces on all sides
let padding = BoxPad::uniform(3);
// Equivalent to BoxPad { top: 3, down: 3, left: 3, right: 3 }

pub fn vh(vertical: usize, horizontal: usize) -> Self

Creates a new BoxPad with separate values for vertical and horizontal padding.

This is a convenience method that applies the same padding to top/bottom and left/right sides.

Arguments

• vertical - Padding for top and bottom
• horizontal - Padding for left and right

Examples

use boxy_cli::prelude::*;

// Create padding with 1 space vertically and 3 spaces horizontally
let padding = BoxPad::vh(1, 3);
// Equivalent to BoxPad { top: 1, down: 1, left: 3, right: 3 }

pub fn lr(&self) -> usize

returns the total padidng on either side. used for text wrapping and display time calculations

Trait Implementations

impl Debug for BoxPad

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

Formats the value using the given formatter.

impl Default for BoxPad

fn default() -> Self

Returns the “default value” for a type.