Struct Property

pub struct Property<T> { /* private fields */ }

A typed wrapper over a UntypedProperty that casts to/from an untyped property on get/set

Implementations

impl<T> Property<T>

where T: PropertyValue,

pub fn new(val: T) -> Property<T>

pub fn new_from_untyped(untyped: UntypedProperty) -> Property<T>

pub fn computed( evaluator: impl Fn() -> T + 'static, dependents: &[UntypedProperty], ) -> Property<T>

pub fn new_with_name(val: T, name: &str) -> Property<T>

pub fn computed_with_name( evaluator: impl Fn() -> T + 'static, dependents: &[UntypedProperty], name: &str, ) -> Property<T>

pub fn ease_to(&self, end_val: T, time: u64, curve: EasingCurve)

pub fn ease_to_later(&self, end_val: T, time: u64, curve: EasingCurve)

pub fn get(&self) -> T

Gets the currently stored value. Might be computationally expensive in a large reactivity network since this triggers re-evaluation of dirty property chains

pub fn set(&self, val: T)

Sets this properties value and sets the dirty bit recursively of all of its dependencies if not already set

pub fn update(&self, f: impl FnOnce(&mut T))

pub fn read<V>(&self, f: impl FnOnce(&T) -> V) -> V

pub fn replace_with(&self, target: Property<T>)

replaces a properties evaluation/inbounds/value to be the same as target, while keeping its dependents. WARNING: this method can introduce circular dependencies if one is not careful. Using it wrongly can introduce memory leaks and inconsistent property behavior. This method can be used to replace an inner value from for example a literal to a computed computed, while keeping the link to its dependents

pub fn untyped(&self) -> UntypedProperty

Casts this property to its untyped version

Trait Implementations

impl<T> Clone for Property<T>

where T: Clone,

fn clone(&self) -> Property<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Property<T>

where T: PropertyValue + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Property<T>

where T: PropertyValue,

fn default() -> Property<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Property<T>

where T: PropertyValue + Deserialize<'de>,

Serialization and deserialization fully disconnects properties, and only loads them back in as literals.

fn deserialize<D>( deserializer: D, ) -> Result<Property<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Interpolatable for Property<T>

where T: PropertyValue,

fn interpolate(&self, other: &Property<T>, t: f64) -> Property<T>

impl<T> Serialize for Property<T>

where T: PropertyValue + Serialize,

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<T> ToPaxValue for Property<T>

where T: ToPaxValue + PropertyValue,

fn to_pax_value(self) -> PaxValue