Struct Layout 

pub struct Layout { /* private fields */ }

A layout engine for dividing rectangular areas using constraints.

Example

use tuxtui_core::layout::{Layout, Constraint, Direction};
use tuxtui_core::geometry::Rect;

let area = Rect::new(0, 0, 100, 50);
let chunks = Layout::default()
    .direction(Direction::Vertical)
    .constraints([
        Constraint::Length(10),
        Constraint::Fill(1),
        Constraint::Length(5),
    ])
    .split(area);

Implementations

impl Layout

pub fn new() -> Self

Create a new layout.

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>,

Set the constraints.

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

Set the flex mode.

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

Set the spacing.

pub fn cache(self, capacity: NonZeroUsize) -> Self

Available on crate feature layout-cache only.

Enable caching with the given capacity.

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

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

Create a horizontal layout with the given constraints.

This is a convenience method for Layout::default().direction(Direction::Horizontal).constraints(...).

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

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

Create a vertical layout with the given constraints.

This is a convenience method for Layout::default().direction(Direction::Vertical).constraints(...).

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

Split the given area according to the constraints.

Returns a vector of rectangles, one for each constraint.

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.