Struct Layout 

pub struct Layout { /* private fields */ }

A layout configuration that splits a Rect into sub-rects.

Implementations

impl Layout

pub fn new<I>(direction: Direction, constraints: I) -> Self

where I: IntoIterator, I::Item: Into<Constraint>,

Create a new layout with the given direction and constraints.

pub fn vertical<I>(constraints: I) -> Self

where I: IntoIterator, I::Item: Into<Constraint>,

Shorthand for Layout::new with Direction::Vertical.

pub fn horizontal<I>(constraints: I) -> Self

where I: IntoIterator, I::Item: Into<Constraint>,

Shorthand for Layout::new with Direction::Horizontal.

pub fn direction(self, direction: Direction) -> Self

Set the layout direction.

pub fn constraints<I>(self, constraints: I) -> Self

where I: IntoIterator, I::Item: Into<Constraint>,

Replace the current constraints.

pub fn margin(self, margin: u16) -> Self

Set uniform margin on all sides.

pub fn horizontal_margin(self, margin: u16) -> Self

Set horizontal margin (left and right).

pub fn vertical_margin(self, margin: u16) -> Self

Set vertical margin (top and bottom).

pub fn flex(self, flex: Flex) -> Self

Set how excess space is distributed.

pub fn spacing<T: Into<Spacing>>(self, spacing: T) -> Self

Set the spacing between layout segments.

impl Layout

pub fn split(&self, area: Rect) -> Vec<Rect>

Split area into sub-rects according to this layout’s constraints.

pub fn areas<const N: usize>(&self, area: Rect) -> [Rect; N]

Like split, but returns a fixed-size array.

Missing segments are filled with Rect::ZERO.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Layout

impl Hash for Layout

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 Layout

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