Struct cushy::value::Dynamic

pub struct Dynamic<T>(/* private fields */);

An instance of a value that provides APIs to observe and react to its contents.

Implementations

impl<T> Dynamic<T>

pub fn new(value: T) -> Self

Creates a new instance wrapping value.

pub fn downgrade(&self) -> WeakDynamic<T>

Returns a weak reference to this dynamic.

This is powered by Arc/Weak and follows the same semantics for reference counting.

pub fn instances(&self) -> usize

Returns the number Dynamics that point to this same value.

The returned count includes self.

Panics

This function panics if this value is already locked by the current thread.

pub fn readers(&self) -> usize

Returns the number of DynamicReaders for this value.

Panics

This function panics if this value is already locked by the current thread.

pub fn linked<R, TIntoR, TIntoRResult, RIntoT, RIntoTResult>( &self, t_into_r: TIntoR, r_into_t: RIntoT, ) -> Dynamic<R>

where T: PartialEq + Send + 'static, R: PartialEq + Send + 'static, TIntoRResult: Into<Option<R>> + Send + 'static, RIntoTResult: Into<Option<T>> + Send + 'static, TIntoR: FnMut(&T) -> TIntoRResult + Send + 'static, RIntoT: FnMut(&R) -> RIntoTResult + Send + 'static,

Returns a new dynamic that has its contents linked with self by the pair of mapping functions provided.

When the returned dynamic is updated, r_into_t will be invoked. This function accepts &R and can return T, or Option<T>. If a value is produced, self will be updated with the new value.

When self is updated, t_into_r will be invoked. This function accepts &T and can return R or Option<R>. If a value is produced, the returned dynamic will be updated with the new value.

Panics

This function panics if calling t_into_r with the current contents of the Dynamic produces a None value. This requirement is only for the first invocation, and it is guaranteed to occur before this function returns.

pub fn linked_string(&self) -> Dynamic<String>

where T: ToString + FromStr + PartialEq + Send + 'static,

Creates a linked dynamic containing a String.

When self is updated, ToString::to_string() will be called to produce a new string value to store in the returned dynamic.

When the returned dynamic is updated, str::parse is called to produce a new T. If an error is returned, self will not be updated. Otherwise, self will be updated with the produced value.

pub fn set_source(&self, source: CallbackHandle)

Sets the current source for this dynamic with source.

A dynamic can have multiple source callbacks.

This ensures that source stays active as long as any clones of self are alive.

pub fn with_for_each<F>(self, for_each: F) -> Self

where T: Send + 'static, F: for<'a> FnMut(&'a T) + Send + 'static,

Attaches for_each to this value so that it is invoked each time the value’s contents are updated. This function returns self.

pub fn with_clone<R>(&self, with_clone: impl FnOnce(Self) -> R) -> R

A helper function that invokes with_clone with a clone of self. This code may produce slightly more readable code.

use cushy::value::{Dynamic, Source};

let value = Dynamic::new(1);

// Using with_clone
value.with_clone(|value| {
    std::thread::spawn(move || {
        println!("{}", value.get());
    })
});

// Using an explicit clone
std::thread::spawn({
    let value = value.clone();
    move || {
        println!("{}", value.get());
    }
});

println!("{}", value.get());

pub fn create_reader(&self) -> DynamicReader<T>

Returns a new reference-based reader for this dynamic value.

Panics

This function panics if this value is already locked by the current thread.

pub fn into_reader(self) -> DynamicReader<T>

Converts this Dynamic into a reader.

Panics

This function panics if this value is already locked by the current thread.

pub fn lock(&self) -> DynamicGuard<'_, T>

Returns an exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

Panics

This function panics if this value is already locked by the current thread.

pub fn try_lock(&self) -> Result<DynamicGuard<'_, T>, DeadlockError>

Returns an exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

Errors

Returns an error if the current thread already holds a lock to this dynamic.

pub fn transition_to(&self, new_value: T) -> DynamicTransition<T>

where T: LinearInterpolate + Clone + Send + Sync,

Returns a pending transition for this value to new_value.

pub fn new_radio(&self, widget_value: T, label: impl MakeWidget) -> Radio<T>

where Self: Clone, T: Clone + PartialEq,

Returns a new Radio that updates this dynamic to widget_value when pressed. label is drawn next to the checkbox and is also clickable to select the radio.

pub fn new_select(&self, widget_value: T, label: impl MakeWidget) -> Select<T>

where Self: Clone, T: Clone + PartialEq,

Returns a new Select that updates this dynamic to widget_value when pressed. label is drawn next to the checkbox and is also clickable to select the widget.

pub fn validate_with<E, Valid>(&self, check: Valid) -> Dynamic<Validation>

where T: Send + 'static, Valid: for<'a> FnMut(&'a T) -> Result<(), E> + Send + 'static, E: Display,

Validates the contents of this dynamic using the check function, returning a dynamic that contains the validation status.

impl Dynamic<WidgetInstance>

pub fn into_switcher(self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic.

pub fn to_switcher(&self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic.

impl Dynamic<WidgetList>

pub fn into_rows(self) -> Stack

Returns self as a vertical Stack of rows.

pub fn to_rows(&self) -> Stack

Returns self as a vertical Stack of rows.

pub fn into_columns(self) -> Stack

Returns self as a horizontal Stack of columns.

pub fn to_columns(&self) -> Stack

Returns self as a horizontal Stack of columns.

pub fn into_layers(self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.

pub fn to_layers(&self) -> Layers

Returns self as Layers, with the widgets being stacked in the Z direction.

pub fn into_list(self) -> List

Returns self as an unordered List.

pub fn to_list(self) -> List

Returns self as an unordered List.

pub fn into_wrap(self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.

pub fn to_wrap(&self) -> Wrap

Returns a Wrap that lays the children out horizontally, wrapping into additional rows as needed.

Trait Implementations

impl<T> Clone for Dynamic<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Dynamic<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Dynamic<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Destination<T> for Dynamic<T>

fn try_map_mut<R>( &self, map: impl FnOnce(Mutable<'_, T>) -> R, ) -> Result<R, DeadlockError>

Maps the contents with exclusive access. Before returning from this function, all observers will be notified that the contents have been updated.

fn map_mut<R>(&self, map: impl FnOnce(Mutable<'_, T>) -> R) -> R

Maps the contents with exclusive access. Before returning from this function, all observers will be notified that the contents have been updated.

impl<T> Drop for Dynamic<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> DynamicRead<T> for Dynamic<T>

fn read(&self) -> DynamicGuard<'_, T, true>

Returns a guard that provides exclusive, read-only access to the value contained wihtin this dynamic.

impl<'a, T> From<&'a Dynamic<T>> for WeakDynamic<T>

fn from(value: &'a Dynamic<T>) -> Self

Converts to this type from the input type.

impl From<&str> for Dynamic<String>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for DynamicReader<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for ReadOnly<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for Value<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<Dynamic<T>> for WeakDynamic<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl From<String> for Dynamic<String>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> IntoComponentValue for Dynamic<T>

where T: Clone + Send + 'static, Component: From<T>,

fn into_component_value(self) -> Value<Component>

Returns self stored in a component value.

impl IntoDynamic<CheckboxState> for Dynamic<Option<bool>>

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.

impl IntoDynamic<CheckboxState> for Dynamic<bool>

fn into_dynamic(self) -> Dynamic<CheckboxState>

Returns self as a dynamic.

impl<T> IntoDynamic<T> for Dynamic<T>

fn into_dynamic(self) -> Dynamic<T>

Returns self as a dynamic.

impl<T, E> IntoDynamic<Validation> for Dynamic<Result<T, E>>

where T: Send + 'static, E: Display + Send + 'static,

fn into_dynamic(self) -> Dynamic<Validation>

Returns self as a dynamic.

impl<T> IntoDynamicComponentValue for Dynamic<T>

where T: ComponentDefinition + Clone + Send + Sync + 'static,

fn into_dynamic_component(self) -> Value<DynamicComponent>

Returns this type converted into a dynamic component value.

impl<T> IntoReadOnly<T> for Dynamic<T>

fn into_read_only(self) -> ReadOnly<T>

Returns self as a ReadOnly.

impl<T> IntoReader<T> for Dynamic<T>

fn into_reader(self) -> DynamicReader<T>

Returns this value as a reader.

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Lp>>

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.

impl IntoValue<ContainerShadow> for Dynamic<ContainerShadow<Px>>

fn into_value(self) -> Value<ContainerShadow>

Returns this type as a Value.

impl IntoValue<CowString> for Dynamic<&'static str>

fn into_value(self) -> Value<CowString>

Returns this type as a Value.

impl IntoValue<CowString> for Dynamic<String>

fn into_value(self) -> Value<CowString>

Returns this type as a Value.

impl IntoValue<MaskedString> for Dynamic<&'static str>

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.

impl IntoValue<MaskedString> for Dynamic<String>

fn into_value(self) -> Value<MaskedString>

Returns this type as a Value.

impl<T> IntoValue<T> for &Dynamic<T>

fn into_value(self) -> Value<T>

Returns this type as a Value.

impl<T> IntoValue<T> for Dynamic<T>

fn into_value(self) -> Value<T>

Returns this type as a Value.

impl MakeWidgetWithTag for Dynamic<&'static str>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<Option<WidgetInstance>>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<String>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl MakeWidgetWithTag for Dynamic<WidgetInstance>

fn make_with_tag(self, id: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl<T> PartialEq<Dynamic<T>> for WeakDynamic<T>

fn eq(&self, other: &Dynamic<T>) -> 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<T> PartialEq<WeakDynamic<T>> for Dynamic<T>

fn eq(&self, other: &WeakDynamic<T>) -> 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<T> PartialEq for Dynamic<T>

fn eq(&self, other: &Self) -> 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<T> Source<T> for Dynamic<T>

fn try_map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> Result<R, DeadlockError>

Maps the contents with read-only access, providing access to the value’s Generation.

fn for_each_subsequent_generational_try<F>(&self, for_each: F) -> CallbackHandle

where T: Send + 'static, F: for<'a> FnMut(DynamicGuard<'_, T, true>) -> Result<(), CallbackDisconnected> + Send + 'static,

Attaches for_each to this value so that it is invoked each time the source’s contents are updated.

fn for_each_generational_cloned_try<F>(&self, for_each: F) -> CallbackHandle

where T: Clone + Send + 'static, F: FnMut(GenerationalValue<T>) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes for_each with the current contents and each time this source’s contents are updated.

fn map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> R

Maps the contents with read-only access, providing access to the value’s Generation.

fn generation(&self) -> Generation

Returns the current generation of the value.

fn map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> R

Maps the contents with read-only access.

fn try_map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> Result<R, DeadlockError>

Maps the contents with read-only access.

impl<T> Eq for Dynamic<T>