Struct LayoutInput

pub struct LayoutInput {
    pub run_mode: RunMode,
    pub sizing_mode: SizingMode,
    pub axis: RequestedAxis,
    pub known_dimensions: Size<Option<f32>>,
    pub parent_size: Size<Option<f32>>,
    pub available_space: Size<AvailableSpace>,
    pub vertical_margins_are_collapsible: Line<bool>,
}

A struct containing the inputs constraints/hints for laying out a node, which are passed in by the parent

Fields

run_mode: RunMode

Whether we only need to know the Node’s size, or whe

sizing_mode: SizingMode

Whether a Node’s style sizes should be taken into account or ignored

axis: RequestedAxis

Which axis we need the size of

known_dimensions: Size<Option<f32>>

Known dimensions represent dimensions (width/height) which should be taken as fixed when performing layout. For example, if known_dimensions.width is set to Some(WIDTH) then this means something like:

“What would the height of this node be, assuming the width is WIDTH”

Layout functions will be called with both known_dimensions set for final layout. Where the meaning is:

“The exact size of this node is WIDTHxHEIGHT. Please lay out your children”

parent_size: Size<Option<f32>>

Parent size dimensions are intended to be used for percentage resolution.

available_space: Size<AvailableSpace>

Available space represents an amount of space to layout into, and is used as a soft constraint for the purpose of wrapping.

vertical_margins_are_collapsible: Line<bool>

Specific to CSS Block layout. Used for correctly computing margin collapsing. You probably want to set this to Line::FALSE.

Implementations

impl LayoutInput

pub const HIDDEN: LayoutInput

A LayoutInput that can be used to request hidden layout

Trait Implementations

impl Clone for LayoutInput

fn clone(&self) -> LayoutInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutInput

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

Formats the value using the given formatter.

impl PartialEq for LayoutInput

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

impl StructuralPartialEq for LayoutInput