Struct AnyVarModify 

pub struct AnyVarModify<'a> { /* private fields */ }

Mutable reference to a variable value.

The variable will notify an update only on deref_mut.

Implementations

impl<'a> AnyVarModify<'a>

pub fn set(&mut self, new_value: BoxAnyVarValue) -> bool

Replace the value if not equal.

Note that you can also deref_mut to modify the value.

pub fn update(&mut self)

Notify an update, even if the value does not actually change.

pub fn tags(&self) -> &[BoxAnyVarValue]

Custom tags that will be shared with the var hooks if the value updates.

The tags where set by previous modify closures or this one during this update cycle, so tags can also be used to communicate between modify closures.

pub fn push_tag(&mut self, tag: impl AnyVarValue)

Add a custom tag object that will be shared with the var hooks if the value updates.

pub fn set_modify_importance(&mut self, importance: usize)

Sets a custom AnyVar::modify_importance value.

Note that the modify info is already automatically set, using a custom value here can easily break all future modify requests for this variable. The importance is set even if the variable does not update (no actual value change or update request).

pub fn downcast<'s, T: VarValue>(&'s mut self) -> Option<VarModify<'s, 'a, T>>

Strongly typed reference, if it is of the same type.

pub fn value(&self) -> &dyn AnyVarValue

Immutable reference to the value.

Note that you can also simply deref to the value.

pub fn value_mut(&mut self) -> &mut dyn AnyVarValue

Mutable reference to the value.

Getting a mutable reference to the value flags the variable to notify update.

Note that you can also simply deref to the value.

Methods from Deref<Target = dyn AnyVarValue>

pub fn downcast_ref<T: VarValue>(&self) -> Option<&T>

Returns some reference to the inner value if it is of type T, or None if it isn’t.

pub fn downcast_mut<T: VarValue>(&mut self) -> Option<&mut T>

Returns some mutable reference to the inner value if it is of type T, or None if it isn’t.

pub fn is<T: VarValue>(&self) -> bool

Returns true if the inner type is the same as T.

Trait Implementations

impl<'a> Deref for AnyVarModify<'a>

type Target = dyn AnyVarValue

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for AnyVarModify<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.