Type Alias UnderlineThickness

pub type UnderlineThickness = Length;

Height of the text underline decoration.

Relative lengths are computed from 1.em(), with a minimum of one pixel.

The Default value is defined by the font.

Aliased Type

enum UnderlineThickness {
    Default,
    Dip(Dip),
    Px(Px),
    Pt(f32),
    Factor(Factor),
    Leftover(Factor),
    Em(Factor),
    RootEm(Factor),
    ViewportWidth(Factor),
    ViewportHeight(Factor),
    ViewportMin(Factor),
    ViewportMax(Factor),
    DipF32(f32),
    PxF32(f32),
    Expr(Box<LengthExpr>),
}

Variants

Default

The default (initial) value.

Dip(Dip)

The exact length in device independent units.

Px(Px)

The exact length in device pixel units.

Pt(f32)

The exact length in font points.

Factor(Factor)

Relative to the fill length.

Leftover(Factor)

Relative to the leftover fill length.

Em(Factor)

Relative to the font-size of the widget.

RootEm(Factor)

Relative to the font-size of the root widget.

ViewportWidth(Factor)

Relative to the width of the nearest viewport ancestor.

ViewportHeight(Factor)

Relative to the height of the nearest viewport ancestor.

ViewportMin(Factor)

Relative to the smallest of the nearest viewport ancestor’s dimensions.

ViewportMax(Factor)

Relative to the smallest of the nearest viewport ancestor’s dimensions.

DipF32(f32)

The exact length in device independent units, defined using a f32 value.

This value will be rounded to the nearest pixel after layout, but it will be used as is in the evaluation of length expressions.

PxF32(f32)

The exact length in device pixel units, defined using a f32 value.

This value will be rounded to the nearest pixel after layout, but it will be used as is in the evaluation of length expressions.

Expr(Box<LengthExpr>)

Expression.

Implementations

impl Length

pub const fn zero() -> Length

Length of exact zero.

pub const fn fill() -> Length

Length that fills the available space.

pub const fn half() -> Length

Length that fills 50% of the available space.

pub fn max(&self, other: impl Into<Length>) -> Length

Returns a length that resolves to the maximum layout length between self and other.

pub fn min(&self, other: impl Into<Length>) -> Length

Returns a length that resolves to the minimum layout length between self and other.

pub fn clamp(&self, min: impl Into<Length>, max: impl Into<Length>) -> Length

Returns a length that constraints the computed layout length between min and max.

pub fn abs(&self) -> Length

Returns a length that computes the absolute layout length of self.

pub fn is_zero(&self) -> Option<bool>

If this length is zero in any finite layout context.

Returns None if the value depends on the default value.

pub fn pt_to_px(pt: f32, scale_factor: Factor) -> Px

Convert a pt unit value to Px given a scale_factor.

pub fn pt_to_px_f32(pt: f32, scale_factor: Factor) -> f32

Same operation as pt_to_px but without rounding to nearest pixel.

pub fn px_to_pt(px: Px, scale_factor: Factor) -> f32

Convert a Px unit value to a Pt value given a scale_factor.

pub fn is_default(&self) -> bool

If is Length::Default.

pub fn replace_default(&mut self, overwrite: &Length)

Replaces self with overwrite if self is Default.

pub fn round_exact(&mut self)

Convert PxF32 to Px and DipF32 to Dip.

pub fn memory_used(&self) -> ByteLength

Gets the total memory allocated by this length.

This includes the sum of all nested Length::Expr heap memory.

pub fn heap_memory_used(&self) -> ByteLength

Sum total memory used in nested Length::Expr heap memory.

Trait Implementations

impl<L> Add<L> for Length

where L: Into<Length>,

type Output = Length

The resulting type after applying the + operator.

fn add(self, rhs: L) -> <Length as Add<L>>::Output

Performs the + operation.

impl<L> AddAssign<L> for Length

where L: Into<Length>,

fn add_assign(&mut self, rhs: L)

Performs the += operation.

impl Clone for Length

fn clone(&self) -> Length

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Length

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

Formats the value using the given formatter.

impl Default for Length

fn default() -> Length

Length::Default

impl<'de> Deserialize<'de> for Length

fn deserialize<__D>( __deserializer: __D, ) -> Result<Length, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Length

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

Formats the value using the given formatter.

impl<F> Div<F> for Length

where F: Into<Factor>,

type Output = Length

The resulting type after applying the / operator.

fn div(self, rhs: F) -> <Length as Div<F>>::Output

Performs the / operation.

impl<F> DivAssign<F> for Length

where F: Into<Factor>,

fn div_assign(&mut self, rhs: F)

Performs the /= operation.

impl From<Dip> for Length

fn from(l: Dip) -> Length

Conversion to Length::Dip

impl From<Factor> for Length

fn from(norm: Factor) -> Length

Conversion to Length::Factor

impl From<FactorPercent> for Length

fn from(percent: FactorPercent) -> Length

Conversion to Length::Factor

impl From<Px> for Length

fn from(l: Px) -> Length

Conversion to Length::Px

impl From<f32> for Length

fn from(f: f32) -> Length

Conversion to Length::DipF32

impl From<i32> for Length

fn from(i: i32) -> Length

Conversion to Length::Dip

impl IntoVar<CornerRadius> for Length

fn into_var(self) -> <Length as IntoVar<CornerRadius>>::Var

All corners same length.

type Var = LocalVar<CornerRadius>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientRadius> for Length

fn into_var(self) -> <Length as IntoVar<GradientRadius>>::Var

Ellipse GradientRadius::farthest_corner.

type Var = LocalVar<GradientRadius>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GradientStop> for Length

type Var = LocalVar<GradientStop>

Variable type that will wrap the T value.

fn into_var(self) -> <Length as IntoVar<GradientStop>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<GridSpacing> for Length

fn into_var(self) -> <Length as IntoVar<GridSpacing>>::Var

Same spacing for both columns and rows.

type Var = LocalVar<GridSpacing>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Point> for Length

fn into_var(self) -> <Length as IntoVar<Point>>::Var

Splat.

type Var = LocalVar<Point>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<SideOffsets> for Length

fn into_var(self) -> <Length as IntoVar<SideOffsets>>::Var

All sides equal.

type Var = LocalVar<SideOffsets>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Size> for Length

fn into_var(self) -> <Length as IntoVar<Size>>::Var

Splat.

type Var = LocalVar<Size>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Vector> for Length

fn into_var(self) -> <Length as IntoVar<Vector>>::Var

Use the length for x and y.

type Var = LocalVar<Vector>

Variable type that will wrap the T value.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl Layout1d for Length

fn layout_dft(&self, axis: LayoutAxis, default: Px) -> Px

Compute the pixel value in the current LAYOUT context with default.

fn layout_f32_dft(&self, axis: LayoutAxis, default: f32) -> f32

Compute the pixel value in the current LAYOUT context with default.

fn affect_mask(&self) -> LayoutMask

Compute a LayoutMask that flags all contextual values that affect the result of layout.

fn layout(&self, axis: LayoutAxis) -> Px

Compute the pixel value in the current LAYOUT context.

fn layout_x(&self) -> Px

Compute the pixel value in the current LAYOUT context x axis.

fn layout_y(&self) -> Px

Compute the pixel value in the current LAYOUT context y axis.

fn layout_z(&self) -> Px

Compute the pixel value in the current LAYOUT context z axis.

fn layout_dft_x(&self, default: Px) -> Px

Compute the pixel value in the current LAYOUT context x axis with default.

fn layout_dft_y(&self, default: Px) -> Px

Compute the pixel value in the current LAYOUT context y axis with default.

fn layout_dft_z(&self, default: Px) -> Px

Compute the pixel value in the current LAYOUT context z axis with default.

fn layout_f32(&self, axis: LayoutAxis) -> f32

Compute the pixel value in the current LAYOUT context.

fn layout_f32_x(&self) -> f32

Compute the pixel value in the current LAYOUT context x axis.

fn layout_f32_y(&self) -> f32

Compute the pixel value in the current LAYOUT context y axis.

fn layout_f32_z(&self) -> f32

Compute the pixel value in the current LAYOUT context z axis.

fn layout_f32_dft_x(&self, default: f32) -> f32

Compute the pixel value in the current LAYOUT context x axis with default.

fn layout_f32_dft_y(&self, default: f32) -> f32

Compute the pixel value in the current LAYOUT context y axis with default.

fn layout_f32_dft_z(&self, default: f32) -> f32

Compute the pixel value in the current LAYOUT context z axis with default.

impl<F> Mul<F> for Length

where F: Into<Factor>,

type Output = Length

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> <Length as Mul<F>>::Output

Performs the * operation.

impl<F> MulAssign<F> for Length

where F: Into<Factor>,

fn mul_assign(&mut self, rhs: F)

Performs the *= operation.

impl Neg for Length

type Output = Length

The resulting type after applying the - operator.

fn neg(self) -> <Length as Neg>::Output

Performs the unary - operation.

impl PartialEq for Length

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<L> Sub<L> for Length

where L: Into<Length>,

type Output = Length

The resulting type after applying the - operator.

fn sub(self, rhs: L) -> <Length as Sub<L>>::Output

Performs the - operation.

impl<L> SubAssign<L> for Length

where L: Into<Length>,

fn sub_assign(&mut self, rhs: L)

Performs the -= operation.

impl Transitionable for Length

fn lerp(self, to: &Length, step: Factor) -> Length

Sample the linear interpolation from self -> to by step.

impl IntoValue<CornerRadius> for Length

impl IntoValue<GradientRadius> for Length

impl IntoValue<GradientStop> for Length

impl IntoValue<GridSpacing> for Length

impl IntoValue<Point> for Length

impl IntoValue<SideOffsets> for Length

impl IntoValue<Size> for Length

impl IntoValue<Vector> for Length