Struct Margin 

pub struct Margin {
    pub horizontal: u16,
    pub vertical: u16,
}

Represents spacing around rectangular areas.

Margin defines the horizontal and vertical spacing that should be applied around a rectangular area. It’s commonly used with Layout to add space between the layout’s boundaries and its contents, or with Rect::inner and Rect::outer to create padded areas.

The margin values represent the number of character cells to add on each side. For horizontal margin, the space is applied to both the left and right sides. For vertical margin, the space is applied to both the top and bottom sides.

Construction

• new - Create a new margin with horizontal and vertical spacing
• default - Create with zero margin

Examples

use ratatui_core::layout::{Constraint, Layout, Margin, Rect};

// Create a margin of 2 cells horizontally and 1 cell vertically
let margin = Margin::new(2, 1);

// Apply directly to a rectangle
let area = Rect::new(0, 0, 80, 24);
let inner_area = area.inner(margin);

// Or use with a layout (which only accepts uniform margins)
let layout = Layout::vertical([Constraint::Fill(1)]).margin(2);

For comprehensive layout documentation and examples, see the layout module.

Fields

horizontal: u16

vertical: u16

Implementations

impl Margin

pub const fn new(horizontal: u16, vertical: u16) -> Margin

Trait Implementations

impl Clone for Margin

fn clone(&self) -> Margin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Margin

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

Formats the value using the given formatter.

impl Default for Margin

fn default() -> Margin

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Margin

fn deserialize<__D>( __deserializer: __D, ) -> Result<Margin, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Margin

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

Formats the value using the given formatter.

impl Hash for Margin

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

where __H: Hasher,

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 Margin

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Margin

impl Eq for Margin

impl StructuralPartialEq for Margin