Enum Units

pub enum Units {
    Pixels(f32),
    Percentage(f32),
    Stretch(f32),
    Auto,
}

Units which describe spacing and size.

Variants

Pixels(f32)

A number of logical pixels.

Percentage(f32)

A percentage of the parent dimension.

A percentage of the parent’s width when applied to left, width, right properties. A percentage of the parent’s height when applied to top, height, bottom properties.

Stretch(f32)

A factor of the remaining free space.

The remaining free space is the parent space minus the space and size of any fixed-size nodes in that axis. The remaining free space is then shared between any stretch nodes based on the ratio of their stretch factors.

For example, given two stretch nodes with factors of 1.0 and 2.0 respectively. The first will occupy 1/3 of the remaining free space while the second will occupy 2/3 of the remaining free space.

Auto

Automatically determine the value.

When applied to space (left, right, top, bottom) the spacing may be overridden by the parent’s child-space on the same side. For example, a node in a column with Auto left space, with a parent which has Pixel(100.0) child-left space, will get a left spacing of 100px.

When applied to size (width, height) Auto will either size to fit its children, or if there are no children the node will be sized based on the content_size property of the node.

Implementations

impl Units

pub fn to_px(&self, parent_value: f32, default: f32) -> f32

Returns the units converted to pixels or a provided default.

pub fn to_px_clamped( &self, parent_value: f32, default: f32, min: Units, max: Units, ) -> f32

pub fn clamp(&self, min: Units, max: Units) -> Self

pub fn is_pixels(&self) -> bool

Returns true if the value is in pixels.

pub fn is_percentage(&self) -> bool

Returns true if the value is a percentage.

pub fn is_stretch(&self) -> bool

Returns true if the value is a stretch factor.

pub fn is_auto(&self) -> bool

Returns true if the value is auto.

Trait Implementations

impl Clone for Units

fn clone(&self) -> Units

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Units

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

Formats the value using the given formatter.

impl Default for Units

fn default() -> Units

Returns the “default value” for a type.

impl Display for Units

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

Formats the value using the given formatter.

impl PartialEq for Units

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

impl StructuralPartialEq for Units