Struct LocalProperty 

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

An owner-thread value or computation in Pax’s reactive graph.

Unlike Property, this handle may contain local values and evaluator captures. It cannot cross threads, even when T itself is transferable.

use pax_runtime_api::LocalProperty;
let value = LocalProperty::new(1_u32);
std::thread::spawn(move || value.get());

Implementations

impl<T: PropertyValue> LocalProperty<T>

pub fn local(&self) -> Self

Clones this owner-thread view without changing its property identity.

pub fn new(val: T) -> Self

Creates a literal property with an initial value.

pub fn new_from_untyped(untyped: UntypedProperty) -> Self

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

Creates a computed property from an evaluator and dependency list.

pub fn computed_with_cutoff( evaluator: impl Fn() -> T + 'static, dependents: &[UntypedProperty], cutoff: impl Fn(&T, &T) -> bool + 'static, ) -> Self

Creates a computed property with a propagation cutoff.

The predicate receives the last accepted value and the newly evaluated candidate. Returning true discards the candidate and stops outbound invalidation at this property; returning false accepts and propagates it. The first evaluation is always accepted.

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

Creates a named literal property, useful for diagnostics.

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

Creates a named computed property, useful for diagnostics.

pub fn computed_with_cutoff_and_name( evaluator: impl Fn() -> T + 'static, dependents: &[UntypedProperty], cutoff: impl Fn(&T, &T) -> bool + 'static, name: &str, ) -> Self

Creates a named cutoff computed property, useful for diagnostics.

pub fn ease_to<D: Into<Duration>>( &self, end_val: T, duration: D, curve: EasingCurve, )

Immediately starts an ease transition from the current value to end_val, over a duration, following curve.

Numeric arguments preserve the historical frame-based behavior. Use Duration::Milliseconds, Duration::Seconds, or Duration::Frames to select an explicit unit.

pub fn ease_to_later<D: Into<Duration>>( &self, end_val: T, duration: D, curve: EasingCurve, )

Enqueues an ease transition from the current value to end_val, over a duration, following curve, which will start after all currently enqueued transitions finish.

pub fn cancel_transitions(&self)

Stops the active transition and clears every queued transition segment.

The property is left at its current eased value. A subsequent LocalProperty::set can therefore take immediate ownership without the cancelled transition overwriting it on the next runtime tick.

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 set_if_neq(&self, val: T) -> bool

where T: PartialEq,

Sets the value only when it differs from the current one.

Returns true when the write changed the property and dirtied dependents.

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

Get access to a mutable reference to the inner value T. Will trigger updates for dependents of this property, regardless of if the value actually changed

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

Reads the inner value by reference.

Panics if this property is already borrowed, which can happen if read is called inside a read of the same property.

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

Replaces this property’s evaluator, dependencies, and value with target, while keeping dependents.

This can introduce circular dependencies if used carelessly. It is intended for changing a property from literal to computed (or vice versa) without severing existing outbound links.

pub fn untyped(&self) -> UntypedProperty

Casts this property to its untyped version.

Trait Implementations

impl<T: Clone> Clone for LocalProperty<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: PropertyValue + Debug> Debug for LocalProperty<T>

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

Formats the value using the given formatter.

impl<T: PropertyValue> Default for LocalProperty<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: PropertyValue + Deserialize<'de>> Deserialize<'de> for LocalProperty<T>

fn deserialize<D>(deserializer: D) -> Result<LocalProperty<T>, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PropertyValue> Interpolatable for LocalProperty<T>

fn interpolate(&self, other: &Self, t: f64) -> Self

Interpolates this value toward other at time t on the unit interval.

impl<T: PropertyValue> PropertyBinding<T> for LocalProperty<T>

fn from_value(value: T) -> Self

Creates independent literal state of this field’s ownership kind.

fn local(&self) -> Self

Obtains the owner-thread view used by generated bindings.

fn from_local(source: Self) -> Self

Aliases a local binding, preserving a shared source when one exists.

impl<T: PropertyValue + Serialize> Serialize for LocalProperty<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ToPaxValue + PropertyValue> ToPaxValue for LocalProperty<T>

fn nested_properties(&self) -> Vec<UntypedProperty>

Live properties read when snapshotting a compound value for PAXEL. Adapters observe these as well as the containing property.

fn to_pax_value(self) -> PaxValue

Converts this value into a PaxValue.

fn to_pax_value_in_graph(self) -> PaxValue

where Self: Sized,

Converts against owner-thread graph views, including nested generated property fields. Requires an entered property graph for shared fields. Ordinary Self::to_pax_value reads published value snapshots.