Skip to main content

Flex

Struct Flex 

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

A flexible layout container.

Implementations§

Source§

impl Flex

Source

pub fn vertical() -> Self

Create a new vertical flex layout.

Source

pub fn horizontal() -> Self

Create a new horizontal flex layout.

Source

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

Set the layout direction.

Source

pub fn constraints( self, constraints: impl IntoIterator<Item = Constraint>, ) -> Self

Set the constraints.

Source

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

Set the margin.

Source

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

Set the gap between items.

Source

pub fn alignment(self, alignment: Alignment) -> Self

Set the alignment.

Source

pub fn flow_direction(self, flow: FlowDirection) -> Self

Set the horizontal flow direction (LTR or RTL).

When set to FlowDirection::Rtl, horizontal layouts are mirrored: the first child appears at the right edge instead of the left. Vertical layouts are not affected.

Source

pub fn constraint_count(&self) -> usize

Number of constraints (and thus output rects from split).

Source

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

Split the given area into smaller rectangles according to the configuration.

Source

pub fn split_with_measurer<F>(&self, area: Rect, measurer: F) -> Vec<Rect>
where F: Fn(usize, u16) -> LayoutSizeHint,

Split area using intrinsic sizing from a measurer callback.

This method enables content-aware layout with Constraint::FitContent, Constraint::FitContentBounded, and Constraint::FitMin.

§Arguments
  • area: Available rectangle
  • measurer: Callback that returns LayoutSizeHint for item at index
§Example
let flex = Flex::horizontal()
    .constraints([Constraint::FitContent, Constraint::Fill]);

let rects = flex.split_with_measurer(area, |idx, available| {
    match idx {
        0 => LayoutSizeHint { min: 5, preferred: 20, max: None },
        _ => LayoutSizeHint::ZERO,
    }
});

Trait Implementations§

Source§

impl Clone for Flex

Source§

fn clone(&self) -> Flex

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 Flex

Source§

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

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

impl Default for Flex

Source§

fn default() -> Flex

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Flex

§

impl RefUnwindSafe for Flex

§

impl Send for Flex

§

impl Sync for Flex

§

impl Unpin for Flex

§

impl UnsafeUnpin for Flex

§

impl UnwindSafe for Flex

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.