Struct Dimension 

pub struct Dimension(/* private fields */);

Available on crate feature layout only.

A unit of linear measurement

This is commonly combined with Rect, Point and Size<T>.

Implementations

impl Dimension

pub const fn length(val: f32) -> Dimension

An absolute length in some abstract units. Users of Taffy may define what they correspond to in their application (pixels, logical pixels, mm, etc) as they see fit.

pub const fn percent(val: f32) -> Dimension

A percentage length relative to the size of the containing block.

NOTE: percentages are represented as a f32 value in the range [0.0, 1.0] NOT the range [0.0, 100.0]

pub const fn auto() -> Dimension

The dimension should be automatically computed according to algorithm-specific rules regarding the default size of boxes.

pub const fn min_content() -> Dimension

The size should be the “min-content” size. This is the smallest size that can fit the item’s contents with ALL soft line-wrapping opportunities taken

pub const fn max_content() -> Dimension

The size should be the “max-content” size. This is the smallest size that can fit the item’s contents with NO soft line-wrapping opportunities taken

pub const fn fit_content() -> Dimension

The size should be computed according to the “fit content” formula: max(min_content, min(max_content, stretch)) where stretch is the size the box would take if it filled the available space

pub const fn fit_content_px(limit: f32) -> Dimension

The size should be computed according to the “fit content” formula: max(min_content, min(max_content, limit)) where limit is a LENGTH value

pub const fn stretch() -> Dimension

The size should be the “stretch-fit” size: the size the box would take if it filled the available space (https://www.w3.org/TR/css-sizing-4/#stretch-fit-sizing)

pub const fn content() -> Dimension

The size should be an automatic size based on the box’s content (https://www.w3.org/TR/css-flexbox-1/#valdef-flex-basis-content)

This keyword is only valid for flex-basis. In any other context it behaves as auto.

pub const fn fit_content_percent(limit: f32) -> Dimension

The size should be computed according to the “fit content” formula: max(min_content, min(max_content, limit)) where limit is a PERCENTAGE value

pub const unsafe fn from_raw(val: CompactLength) -> Dimension

Create a LengthPercentageAuto from a raw CompactLength.

Safety

CompactLength must represent a valid variant for LengthPercentageAuto

pub const fn into_raw(self) -> CompactLength

Get the underlying CompactLength representation of the value

pub fn into_option(self) -> Option<f32>

Available on crate feature grid only.

Get Length value if value is Length variant

pub fn is_auto(self) -> bool

Returns true if value is Auto

pub fn is_sizing_keyword(self) -> bool

Returns true if value is min-content, max-content, fit-content, fit-content(…), or stretch

pub fn is_stretch(self) -> bool

Returns true if value is the stretch keyword

pub fn is_content(self) -> bool

Returns true if value is the content keyword

pub fn tag(self) -> usize

Get the raw CompactLength tag

pub fn value(self) -> f32

Get the raw CompactLength value for non-calc variants that have a numeric parameter

pub fn expand(self) -> ExpandedDimension

Expand the compact representation into an ExpandedDimension enum.

This is useful when integrating with other libraries (e.g. for style inspection or serialization) as it allows the value to be pattern-matched without having to work with the raw CompactLength tagged-pointer representation directly.

Trait Implementations

impl Clone for Dimension

fn clone(&self) -> Dimension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Dimension

impl Debug for Dimension

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

Formats the value using the given formatter.

impl From<Dimension> for MinMax<MinTrackSizingFunction, MaxTrackSizingFunction>

fn from( input: Dimension, ) -> MinMax<MinTrackSizingFunction, MaxTrackSizingFunction>

Converts to this type from the input type.

impl From<ExpandedDimension> for Dimension

fn from(value: ExpandedDimension) -> Dimension

Converts to this type from the input type.

impl From<LengthPercentage> for Dimension

fn from(input: LengthPercentage) -> Dimension

Converts to this type from the input type.

impl From<LengthPercentageAuto> for Dimension

fn from(input: LengthPercentageAuto) -> Dimension

Converts to this type from the input type.

impl FromLength for Dimension

fn from_length<Input>(value: Input) -> Dimension

where Input: Into<f64> + Copy,

Converts into an Into<f64> into Self

impl FromPercent for Dimension

fn from_percent<Input>(value: Input) -> Dimension

where Input: Into<f64> + Copy,

Converts into an Into<f64> into Self

impl MaybeResolve<Option<f32>, Option<f32>> for Dimension

fn maybe_resolve( self, context: Option<f32>, calc: impl Fn(*const (), f32) -> f32, ) -> Option<f32>

Converts the given Dimension into an absolute length

Can return None

impl PartialEq for Dimension

fn eq(&self, other: &Dimension) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ResolveOrZero<Option<f32>, f32> for Dimension

fn resolve_or_zero( self, context: Option<f32>, calc: impl Fn(*const (), f32) -> f32, ) -> f32

Will return a default value of result is evaluated to None

impl StructuralPartialEq for Dimension

impl TaffyAuto for Dimension

const AUTO: Dimension

The auto value for type implementing TaffyAuto

impl TaffyZero for Dimension

const ZERO: Dimension

The zero value for type implementing TaffyZero