Enum Length 

#[non_exhaustive]
pub enum Length<const DEFAULT_AUTO: bool = true> {
    Auto,
    Percentage(f32),
    Rem(f32),
    Em(f32),
    Lh(f32),
    Rlh(f32),
    Vh(f32),
    Vw(f32),
    CqH(f32),
    CqW(f32),
    CqMin(f32),
    CqMax(f32),
    VMin(f32),
    VMax(f32),
    Cm(f32),
    Mm(f32),
    In(f32),
    Q(f32),
    Pt(f32),
    Pc(f32),
    Px(f32),
    Calc(CalcFormula),
}

Represents a value that can be a specific length, percentage, or automatic.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Automatic sizing based on content

Percentage(f32)

Percentage value relative to parent container (0-100)

Rem(f32)

Rem value relative to the root font size

Em(f32)

Em value relative to the font size

Lh(f32)

Lh value relative to the element’s computed line-height

Rlh(f32)

Rlh value relative to the root element’s computed line-height

Vh(f32)

Vh value relative to the viewport height (0-100)

Vw(f32)

Vw value relative to the viewport width (0-100)

CqH(f32)

Cqh value relative to the query container height (0-100)

CqW(f32)

Cqw value relative to the query container width (0-100)

CqMin(f32)

Cqmin value relative to the query container smaller dimension (0-100)

CqMax(f32)

Cqmax value relative to the query container larger dimension (0-100)

VMin(f32)

Vmin value relative to the smaller viewport dimension (0-100)

VMax(f32)

Vmax value relative to the larger viewport dimension (0-100)

Cm(f32)

Centimeter value

Mm(f32)

Millimeter value

In(f32)

Inch value

Q(f32)

Quarter value

Pt(f32)

Point value

Pc(f32)

Picas value

Px(f32)

Specific pixel value

Calc(CalcFormula)

calc(…) expression

Implementations

impl<const DEFAULT_AUTO: bool> Length<DEFAULT_AUTO>

pub fn from_spacing(units: f32) -> Self

Construct a length from a Tailwind spacing-scale multiplier.

impl<const DEFAULT_AUTO: bool> Length<DEFAULT_AUTO>

pub const fn zero() -> Self

Returns a zero pixel length unit.

pub fn try_negative(self) -> Option<Self>

Negated value, or None for non-negatable forms like auto.

pub fn negative(self) -> Self

Returns a negative length unit.

impl<const DEFAULT_AUTO: bool> Length<DEFAULT_AUTO>

pub fn to_compact_length(self, sizing: &SizingContext) -> CompactLength

pub fn resolve_to_length_percentage( self, sizing: &SizingContext, ) -> LengthPercentage

pub fn to_px(self, sizing: &SizingContext, percentage_full_px: f32) -> f32

pub fn resolve_to_length_percentage_auto( self, sizing: &SizingContext, ) -> LengthPercentageAuto

pub fn resolve_to_dimension(self, sizing: &SizingContext) -> Dimension

Trait Implementations

impl<const DEFAULT_AUTO: bool> Clone for Length<DEFAULT_AUTO>

fn clone(&self) -> Length<DEFAULT_AUTO>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const DEFAULT_AUTO: bool> Copy for Length<DEFAULT_AUTO>

impl<const DEFAULT_AUTO: bool> Debug for Length<DEFAULT_AUTO>

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

Formats the value using the given formatter.

impl<const DEFAULT_AUTO: bool> Default for Length<DEFAULT_AUTO>

fn default() -> Self

Returns the “default value” for a type.

impl From<Length> for PositionComponent

fn from(value: Length) -> Self

Converts to this type from the input type.

impl From<Length> for FontSize

fn from(value: Length) -> Self

Converts to this type from the input type.

impl From<Length> for LineHeight

fn from(value: Length) -> Self

Converts to this type from the input type.

impl From<PositionComponent> for Length

fn from(component: PositionComponent) -> Self

Converts to this type from the input type.

impl<const DEFAULT_AUTO: bool> From<f32> for Length<DEFAULT_AUTO>

fn from(value: f32) -> Self

Converts to this type from the input type.

impl<'i, const DEFAULT_AUTO: bool> FromCss<'i> for Length<DEFAULT_AUTO>

const VALID_TOKENS: &'static [CssToken]

Returns the list of valid CSS tokens for this type.

fn from_css(input: &mut Parser<'i, '_>) -> ParseResult<'i, Self>

Parses the type from a Parser instance.

fn from_str(source: &'i str) -> ParseResult<'i, Self>

where Self: Sized,

Helper function to parse the type from a string.

const EXPECT_MESSAGE: CssExpectedMessage = CssExpectedMessage::OneValue

Message template used when building parse errors for this type.

impl<const DEFAULT_AUTO: bool> Neg for Length<DEFAULT_AUTO>

type Output = Length<DEFAULT_AUTO>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const DEFAULT_AUTO: bool> PartialEq for Length<DEFAULT_AUTO>

fn eq(&self, other: &Length<DEFAULT_AUTO>) -> 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<const DEFAULT_AUTO: bool> StructuralPartialEq for Length<DEFAULT_AUTO>

impl<const DEFAULT_AUTO: bool> TailwindPropertyParser for Length<DEFAULT_AUTO>

fn parse_tw(token: &str) -> Option<Self>

Parse a tailwind property from a token.

fn parse_tw_with_arbitrary(token: &str) -> Option<Self>

Parse a tailwind property from a token, with support for arbitrary values.

impl<const DEFAULT_AUTO: bool> ToCss for Length<DEFAULT_AUTO>

fn to_css<W: Write>(&self, dest: &mut W) -> Result

Write the CSS representation of this value into dest.