Enum zng_layout::unit::Length

source ·
pub enum Length {
Show 15 variants 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>),
}
Expand description

1D length units.

See LengthUnits for more details.

§Equality

Two lengths are equal if they are of the same variant and if:

  • Dip and px lengths uses Dip and Px equality.
  • Relative, Em, RootEm lengths use the Factor equality.
  • Viewport lengths uses about_eq with 0.00001 epsilon.

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§

source§

impl Length

source

pub const fn zero() -> Length

Length of exact zero.

source

pub const fn fill() -> Length

Length that fills the available space.

source

pub const fn half() -> Length

Length that fills 50% of the available space.

source

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

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

source

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

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

source

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.

source

pub fn abs(&self) -> Length

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

source

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.

source

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

Convert a pt unit value to Px given a scale_factor.

source

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

Same operation as pt_to_px but without rounding to nearest pixel.

source

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

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

source

pub fn is_default(&self) -> bool

source

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

Replaces self with overwrite if self is Default.

source

pub fn round_exact(&mut self)

Convert PxF32 to Px and DipF32 to Dip.

source

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.

source

pub fn heap_memory_used(&self) -> ByteLength

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

Trait Implementations§

source§

impl<L: Into<Length>> Add<L> for Length

source§

type Output = Length

The resulting type after applying the + operator.
source§

fn add(self, rhs: L) -> Self::Output

Performs the + operation. Read more
source§

impl<L: Into<Length>> AddAssign<L> for Length

source§

fn add_assign(&mut self, rhs: L)

Performs the += operation. Read more
source§

impl Clone for Length

source§

fn clone(&self) -> Length

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Length

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Length

source§

fn default() -> Self

Length::Default

source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Length

source§

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

Formats the value using the given formatter. Read more
source§

impl<F: Into<Factor>> Div<F> for Length

source§

type Output = Length

The resulting type after applying the / operator.
source§

fn div(self, rhs: F) -> Self::Output

Performs the / operation. Read more
source§

impl<F: Into<Factor>> DivAssign<F> for Length

source§

fn div_assign(&mut self, rhs: F)

Performs the /= operation. Read more
source§

impl From<Dip> for Length

source§

fn from(l: Dip) -> Self

Conversion to Length::Dip

source§

impl From<Factor> for Length

source§

fn from(norm: Factor) -> Self

Conversion to Length::Factor

source§

impl From<FactorPercent> for Length

source§

fn from(percent: FactorPercent) -> Self

Conversion to Length::Factor

source§

impl From<Length> for GridSpacing

source§

fn from(all: Length) -> Self

Same spacing for both columns and rows.

source§

impl From<Length> for Point

source§

fn from(all: Length) -> Self

Splat.

source§

impl From<Length> for SideOffsets

source§

fn from(all: Length) -> Self

All sides equal.

source§

impl From<Length> for Size

source§

fn from(all: Length) -> Self

Splat.

source§

impl From<Length> for Vector

source§

fn from(length: Length) -> Self

Use the length for x and y.

source§

impl From<Px> for Length

source§

fn from(l: Px) -> Self

Conversion to Length::Px

source§

impl From<f32> for Length

source§

fn from(f: f32) -> Self

Conversion to Length::DipF32

source§

impl From<i32> for Length

source§

fn from(i: i32) -> Self

Conversion to Length::Dip

source§

impl IntoVar<GridSpacing> for Length

source§

fn into_var(self) -> Self::Var

Same spacing for both columns and rows.

source§

type Var = LocalVar<GridSpacing>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for Dip

source§

fn into_var(self) -> Self::Var

Conversion to Length::Dip

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for Factor

source§

fn into_var(self) -> Self::Var

Conversion to Length::Factor

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for FactorPercent

source§

fn into_var(self) -> Self::Var

Conversion to Length::Factor

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for Px

source§

fn into_var(self) -> Self::Var

Conversion to Length::Px

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for f32

source§

fn into_var(self) -> Self::Var

Conversion to Length::DipF32

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Length> for i32

source§

fn into_var(self) -> Self::Var

Conversion to Length::Dip

source§

type Var = LocalVar<Length>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Point> for Length

source§

fn into_var(self) -> Self::Var

Splat.

source§

type Var = LocalVar<Point>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<SideOffsets> for Length

source§

fn into_var(self) -> Self::Var

All sides equal.

source§

type Var = LocalVar<SideOffsets>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Size> for Length

source§

fn into_var(self) -> Self::Var

Splat.

source§

type Var = LocalVar<Size>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl IntoVar<Vector> for Length

source§

fn into_var(self) -> Self::Var

Use the length for x and y.

source§

type Var = LocalVar<Vector>

Variable type that will wrap the T value. Read more
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
source§

impl Layout1d for Length

source§

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

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

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

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

fn affect_mask(&self) -> LayoutMask

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

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

Compute the pixel value in the current LAYOUT context.
source§

fn layout_x(&self) -> Px

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

fn layout_y(&self) -> Px

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

fn layout_z(&self) -> Px

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

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

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

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

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

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

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

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

Compute the pixel value in the current LAYOUT context.
source§

fn layout_f32_x(&self) -> f32

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

fn layout_f32_y(&self) -> f32

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

fn layout_f32_z(&self) -> f32

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

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

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

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

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

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

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

impl<F: Into<Factor>> Mul<F> for Length

source§

type Output = Length

The resulting type after applying the * operator.
source§

fn mul(self, rhs: F) -> Self::Output

Performs the * operation. Read more
source§

impl<F: Into<Factor>> MulAssign<F> for Length

source§

fn mul_assign(&mut self, rhs: F)

Performs the *= operation. Read more
source§

impl Neg for Length

source§

type Output = Length

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl PartialEq for Length

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for Length

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl<L: Into<Length>> Sub<L> for Length

source§

type Output = Length

The resulting type after applying the - operator.
source§

fn sub(self, rhs: L) -> Self::Output

Performs the - operation. Read more
source§

impl<L: Into<Length>> SubAssign<L> for Length

source§

fn sub_assign(&mut self, rhs: L)

Performs the -= operation. Read more
source§

impl Transitionable for Length

source§

fn lerp(self, to: &Self, step: EasingStep) -> Self

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

impl IntoValue<GridSpacing> for Length

source§

impl IntoValue<Length> for Dip

source§

impl IntoValue<Length> for Factor

source§

impl IntoValue<Length> for FactorPercent

source§

impl IntoValue<Length> for Px

source§

impl IntoValue<Length> for f32

source§

impl IntoValue<Length> for i32

source§

impl IntoValue<Point> for Length

source§

impl IntoValue<SideOffsets> for Length

source§

impl IntoValue<Size> for Length

source§

impl IntoValue<Vector> for Length

Auto Trait Implementations§

§

impl Freeze for Length

§

impl RefUnwindSafe for Length

§

impl Send for Length

§

impl Sync for Length

§

impl Unpin for Length

§

impl UnwindSafe for Length

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyVarValue for T
where T: VarValue,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.
source§

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.
source§

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.
source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.
source§

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoVar<T> for T
where T: VarValue,

source§

type Var = LocalVar<T>

Variable type that will wrap the T value. Read more
source§

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

Converts the source value into a var.
source§

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T> ToTxt for T
where T: ToString,

source§

fn to_txt(&self) -> Txt

Converts the given value to an owned Txt. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> IntoValue<T> for T
where T: VarValue,

source§

impl<T> VarValue for T
where T: Debug + Clone + PartialEq + Any + Send + Sync,