Skip to main content

Layout

Struct Layout 

Source
pub struct Layout { /* private fields */ }
Expand description

A renderable that divides a fixed height in to rows or columns.

Implementations§

Source§

impl Layout

Source

pub fn new() -> Self

Create a new Layout with a placeholder renderable.

Source

pub fn with_renderable(renderable: impl Renderable + 'static) -> Self

Create a new leaf layout with a renderable.

Source

pub fn with_name(self, name: impl Into<String>) -> Self

Source

pub fn with_size(self, size: usize) -> Self

Source

pub fn with_minimum_size(self, minimum_size: usize) -> Self

Source

pub fn with_ratio(self, ratio: usize) -> Self

Source

pub fn with_visible(self, visible: bool) -> Self

Source

pub fn id(&self) -> usize

Source

pub fn name(&self) -> Option<String>

Source

pub fn children(&self) -> Vec<Layout>

Source

pub fn get(&self, name: &str) -> Option<Layout>

Source

pub fn update(&self, renderable: impl Renderable + 'static)

Source

pub fn split(&self, splitter: SplitterKind, layouts: Vec<Layout>)

Source

pub fn split_row(&self, layouts: Vec<Layout>)

Source

pub fn split_column(&self, layouts: Vec<Layout>)

Source

pub fn add_split(&self, layouts: Vec<Layout>)

Source

pub fn unsplit(&self)

Source

pub fn refresh_screen( &self, console: &mut Console<Stdout>, layout_name: &str, ) -> Result<()>

Refresh a sub-layout in an alternate screen.

This matches Rich’s Layout.refresh_screen behavior and requires alt-screen mode.

Source§

impl Layout

Source

pub fn to_tree(&self) -> Tree

Build a Tree renderable that visualises the layout hierarchy.

This matches Python Rich’s Layout.tree property: each node shows the layout name (or “”), its splitter direction, and size/ratio info.

Trait Implementations§

Source§

impl Clone for Layout

Source§

fn clone(&self) -> Layout

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Layout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Renderable for Layout

Source§

fn render(&self, console: &Console, options: &ConsoleOptions) -> Segments

Render this object to a sequence of segments.
Source§

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

Measure the minimum and maximum width requirements. Read more

Auto Trait Implementations§

§

impl Freeze for Layout

§

impl RefUnwindSafe for Layout

§

impl Send for Layout

§

impl Sync for Layout

§

impl Unpin for Layout

§

impl UnwindSafe for Layout

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.