Struct Padding

pub struct Padding {
    pub left: u16,
    pub right: u16,
    pub top: u16,
    pub bottom: u16,
}

Defines the padding for a Block.

See the padding method of Block to configure its padding.

This concept is similar to CSS padding.

NOTE: Terminal cells are often taller than they are wide, so to make horizontal and vertical padding seem equal, doubling the horizontal padding is usually pretty good.

Example

use ratatui::widgets::Padding;

Padding::uniform(1);
Padding::horizontal(2);
Padding::left(3);
Padding::proportional(4);
Padding::symmetric(5, 6);

Fields

left: u16

Left padding

right: u16

Right padding

top: u16

Top padding

bottom: u16

Bottom padding

Implementations

impl Padding

pub const ZERO: Self

Padding with all fields set to 0

pub const fn new(left: u16, right: u16, top: u16, bottom: u16) -> Self

Creates a new Padding by specifying every field individually.

Note: the order of the fields does not match the order of the CSS properties.

pub const fn zero() -> Self

👎Deprecated: use Padding::ZERO

Creates a Padding with all fields set to 0.

pub const fn horizontal(value: u16) -> Self

Creates a Padding with the same value for left and right.

pub const fn vertical(value: u16) -> Self

Creates a Padding with the same value for top and bottom.

pub const fn uniform(value: u16) -> Self

Creates a Padding with the same value for all fields.

pub const fn proportional(value: u16) -> Self

Creates a Padding that is visually proportional to the terminal.

This represents a padding of 2x the value for left and right and 1x the value for top and bottom.

pub const fn symmetric(x: u16, y: u16) -> Self

Creates a Padding that is symmetric.

The x value is used for left and right and the y value is used for top and bottom.

pub const fn left(value: u16) -> Self

Creates a Padding that only sets the left padding.

pub const fn right(value: u16) -> Self

Creates a Padding that only sets the right padding.

pub const fn top(value: u16) -> Self

Creates a Padding that only sets the top padding.

pub const fn bottom(value: u16) -> Self

Creates a Padding that only sets the bottom padding.

Trait Implementations

impl Clone for Padding

fn clone(&self) -> Padding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Padding

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

Formats the value using the given formatter.

impl Default for Padding

fn default() -> Padding

Returns the “default value” for a type.

impl Hash for Padding

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 Ord for Padding

fn cmp(&self, other: &Padding) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Padding

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

fn partial_cmp(&self, other: &Padding) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Padding

impl Eq for Padding

impl StructuralPartialEq for Padding