Enum Val

pub enum Val {
    Auto,
    Px(f32),
    Percent(f32),
    Vw(f32),
    Vh(f32),
    VMin(f32),
    VMax(f32),
}

Represents the possible value types for layout properties.

This enum allows specifying values for various Node properties in different units, such as logical pixels, percentages, or automatically determined values.

Val also implements core::str::FromStr to allow parsing values from strings in the format #.#px. Whitespaces between the value and unit is allowed. The following units are supported:

• px: logical pixels
• %: percentage
• vw: percentage of the viewport width
• vh: percentage of the viewport height
• vmin: percentage of the viewport’s smaller dimension
• vmax: percentage of the viewport’s larger dimension

Additionally, auto will be parsed as Val::Auto.

Variants

Auto

Automatically determine the value based on the context and other Node properties.

Px(f32)

Set this value in logical pixels.

Percent(f32)

Set the value as a percentage of its parent node’s length along a specific axis.

If the UI node has no parent, the percentage is calculated based on the window’s length along the corresponding axis.

The chosen axis depends on the Node field set:

• For flex_basis, the percentage is relative to the main-axis length determined by the flex_direction.
• For gap, min_size, size, and max_size:
  • width is relative to the parent’s width.
  • height is relative to the parent’s height.
• For margin, padding, and border values: the percentage is relative to the parent node’s width.
• For positions, left and right are relative to the parent’s width, while bottom and top are relative to the parent’s height.

Vw(f32)

Set this value in percent of the viewport width

Vh(f32)

Set this value in percent of the viewport height

VMin(f32)

Set this value in percent of the viewport’s smaller dimension.

VMax(f32)

Set this value in percent of the viewport’s larger dimension.

Implementations

impl Val

pub const DEFAULT: Val = Self::Auto

pub const ZERO: Val

impl Val

pub fn resolve( self, parent_size: f32, viewport_size: Vec2, ) -> Result<f32, ValArithmeticError>

Resolves a Val from the given context values and returns this as an f32. The Val::Px value (if present), parent_size and viewport_size should all be in the same coordinate space. Returns a ValArithmeticError::NonEvaluable if the Val is impossible to resolve into a concrete value.

Note: If a Val::Px is resolved, its inner value is returned unchanged.

Trait Implementations

impl Clone for Val

fn clone(&self) -> Val

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.

impl Default for Val

fn default() -> Val

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Val

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f32> for Val

type Output = Val

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> <Val as Div<f32>>::Output

Performs the / operation.

impl DivAssign<f32> for Val

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Enum for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, __name_param: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field (in the current variant) with the given name.

fn field_at( &self, __index_param: usize, ) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field (in the current variant) at the given index.

fn field_mut( &mut self, __name_param: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) with the given name.

fn field_at_mut( &mut self, __index_param: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

fn name_at(&self, __index_param: usize) -> Option<&str>

Returns the name of the field (in the current variant) with the given index.

fn iter_fields(&self) -> VariantFieldIter<'_>

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn to_dynamic_enum(&self) -> DynamicEnum

Creates a new DynamicEnum from this enum.

fn clone_dynamic(&self) -> DynamicEnum

👎Deprecated since 0.16.0: use to_dynamic_enum instead

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

fn get_represented_enum_info(&self) -> Option<&'static EnumInfo>

Will return None if TypeInfo is not available.

impl FromArg for &'static Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg Val

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static Val as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut Val

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut Val as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = Val

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Val as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(__param0: &(dyn PartialReflect + 'static)) -> Option<Val>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl FromStr for Val

type Err = ValParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Val, <Val as FromStr>::Err>

Parses a string s to return a value of this type.

impl GetOwnership for &Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for &Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &Val: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut Val: 'into_return,

Converts Self into a Return value.

impl IntoReturn for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where Val: 'into_return,

Converts Self into a Return value.

impl Mul<f32> for Val

type Output = Val

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Val as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<f32> for Val

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Val

type Output = Val

The resulting type after applying the - operator.

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

Performs the unary - operation.

impl PartialEq for Val

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

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, __value_param: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Val>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Val>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Val>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Val>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for Val

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 TypePath for Val

where Val: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Val

where Val: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Val