Struct LengthPercentage 

pub struct LengthPercentage(pub(crate) CompactLength);

A unit of linear measurement

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

Tuple Fields

0: CompactLength

Implementations

impl LengthPercentage

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 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 const unsafe fn from_raw(val: CompactLength) -> Self

Create a LengthPercentage from a raw CompactLength.

Safety

CompactLength must represent a valid variant for LengthPercentage

pub const fn into_raw(self) -> CompactLength

Get the underlying CompactLength representation of the value

pub fn expand(self) -> ExpandedLengthPercentage

Expand the compact representation into an ExpandedLengthPercentage 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 LengthPercentage

fn clone(&self) -> LengthPercentage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LengthPercentage

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

Formats the value using the given formatter.

impl From<ExpandedLengthPercentage> for LengthPercentage

fn from(value: ExpandedLengthPercentage) -> 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<LengthPercentage> for ExpandedLengthPercentage

fn from(value: LengthPercentage) -> Self

Converts to this type from the input type.

impl From<LengthPercentage> for LengthPercentageAuto

fn from(input: LengthPercentage) -> Self

Converts to this type from the input type.

impl From<LengthPercentage> for MaxTrackSizingFunction

fn from(input: LengthPercentage) -> Self

Converts to this type from the input type.

impl From<LengthPercentage> for TrackSizingFunction

fn from(input: LengthPercentage) -> Self

Converts to this type from the input type.

impl From<LengthPercentage> for MinTrackSizingFunction

fn from(input: LengthPercentage) -> Self

Converts to this type from the input type.

impl FromLength for LengthPercentage

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

Converts into an Into<f64> into Self

impl FromPercent for LengthPercentage

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

Converts into an Into<f64> into Self

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

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

Converts the given LengthPercentage into an absolute length Can return None

impl PartialEq for LengthPercentage

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

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 TaffyZero for LengthPercentage

const ZERO: Self

The zero value for type implementing TaffyZero

impl Copy for LengthPercentage

impl StructuralPartialEq for LengthPercentage