Struct Dimension

pub struct Dimension(pub(crate) CompactLength);

A unit of linear measurement

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

Tuple Fields

0: CompactLength

Implementations

impl Dimension

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

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) -> Self

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() -> Self

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

pub fn calc(ptr: *const ()) -> Self

A calc() value. The value passed here is treated as an opaque handle to the actual calc representation and may be a pointer, index, etc.

The low 3 bits are used as a tag value and will be returned as 0.

pub unsafe fn from_raw(val: CompactLength) -> Self

Create a LengthPercentageAuto from a raw CompactLength.

Safety

CompactLength must represent a valid variant for LengthPercentageAuto

pub fn into_raw(self) -> CompactLength

Get the underlying CompactLength representation of the value

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

Get Length value if value is Length variant

pub fn is_auto(self) -> bool

Returns true if value is Auto

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

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 Debug for Dimension

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

Formats the value using the given formatter.

impl From<Dimension> for MaxTrackSizingFunction

fn from(input: Dimension) -> Self

Converts to this type from the input type.

impl From<Dimension> for TrackSizingFunction

fn from(input: Dimension) -> Self

Converts to this type from the input type.

impl From<Dimension> for MinTrackSizingFunction

fn from(input: Dimension) -> Self

Converts to this type from the input type.

impl From<LengthPercentage> for Dimension

fn from(input: LengthPercentage) -> Self

Converts to this type from the input type.

impl From<LengthPercentageAuto> for Dimension

fn from(input: LengthPercentageAuto) -> Self

Converts to this type from the input type.

impl FromLength for Dimension

fn from_length<Input: Into<f32> + Copy>(value: Input) -> Self

Converts into an Into<f32> into Self

impl FromPercent for Dimension

fn from_percent<Input: Into<f32> + Copy>(value: Input) -> Self

Converts into an Into<f32> 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

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 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 TaffyAuto for Dimension

const AUTO: Self

The auto value for type implementing TaffyAuto

impl TaffyZero for Dimension

const ZERO: Self

The zero value for type implementing TaffyZero

impl Copy for Dimension

impl StructuralPartialEq for Dimension