Struct oxygengine_user_interface::raui::core::data_binding::DataBinding

pub struct DataBinding<T>where
    T: Debug + Default + Send + Sync,{ /* private fields */ }

Wraps internal data and optionally notifies an Application of changes to it

See module docs for a full example.

Implementations

impl<T> DataBinding<T>where T: Debug + Default + Send + Sync,

pub fn new(data: T) -> DataBinding<T>

Create a new DataBinding that wraps data

It will create the data as unbound meaning that changes to the data will not notify any Application. The DataBinding can afterwards be bound with the bind method.

pub fn new_bound(data: T, notifier: ChangeNotifier) -> DataBinding<T>

Create a new DataBinding that wraps data and notifies an Application’s ChangeNotifier when the data is mutated.

pub fn bind(&mut self, notifier: ChangeNotifier)

Bind this DataBinding to a ChangeNotifier

pub fn unbind(&mut self)

Unbind this DataBinding so that changes to the data no longer trigger application updates

pub fn access<F, R>(&self, f: F) -> Option<R>where F: FnMut(&T) -> R,

Access the inner data of the binding inside of the provided closure

This will return None and will not run the supplied closure if a lock to the inner data cannot be obtained due to lock poisoning.

Example

let binding = DataBinding::new(false);

let x = binding.access(|data| {
    // Return the opposite of what's in our data
    !data
});

assert_eq!(x, Some(true));

pub fn read_cloned(&self) -> Option<T>where T: Clone,

Get a clone of the inner data

Returns None if the internal lock to the inner data has been poisoned.

pub fn read_cloned_or_default(&self) -> Twhere T: Clone,

Attempt to obtain a clone of the inner data or otherwise return the type’s default value

pub fn mutate<F, R>(&mut self, f: F) -> Option<R>where F: FnMut(&mut T) -> R,

Use a closure to mutate the inner data and notify the ChangeNotifier ( if set )

This will return None and will not run the supplied closure if a lock to the inner data cannot be obtained due to lock poisoning.

Example

let mut binding = DataBinding::new(false);

let x = binding.mutate(|data| {
    // Update the data
    *data = true;

    *data
});

assert_eq!(x, Some(true));
assert_eq!(binding.read_cloned(), Some(true));

pub fn write(&mut self, v: T)

Set the inner data directly and notify the ChangeNotifier ( if set )

Trait Implementations

impl<T> Clone for DataBinding<T>where T: Clone + Debug + Default + Send + Sync,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DataBinding<T>where T: Debug + Default + Send + Sync,

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

Formats the value using the given formatter.

impl<T> Default for DataBinding<T>where T: Default + Debug + Send + Sync,

fn default() -> DataBinding<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for DataBinding<T>where T: Debug + Default + Send + Sync,

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

Deserialize this value from the given Serde deserializer.

impl<T> MessageData for DataBinding<T>where DataBinding<T>: Clone, T: 'static + Debug + Default + Send + Sync,

fn clone_message(&self) -> Box<dyn MessageData, Global>

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

impl<T> Prefab for DataBinding<T>where T: Debug + Default + Send + Sync,

fn from_prefab(data: Value) -> Result<Self, PrefabError>

fn to_prefab(&self) -> Result<Value, PrefabError>

impl<T> PropsData for DataBinding<T>where DataBinding<T>: Clone, T: 'static + Debug + Default + Send + Sync,

fn clone_props(&self) -> Box<dyn PropsData, Global>

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

impl<T> Serialize for DataBinding<T>where T: Debug + Default + Send + Sync,

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.