Struct VarModify 

pub struct VarModify<'s, 'a, T>
where
    T: VarValue,
{ /* private fields */ }

Mutable reference to a variable value.

The variable will notify an update only on deref_mut.

Implementations

impl<'s, 'a, T> VarModify<'s, 'a, T>

where T: VarValue,

pub fn set(&mut self, new_value: impl Into<T>) -> 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 as_any(&mut self) -> &mut AnyVarModify<'a>

Type erased reference.

pub fn value(&self) -> &T

Immutable reference to the value.

Note that you can also simply deref to the value.

pub fn value_mut(&mut self) -> &mut T

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.

Trait Implementations

impl<'s, 'a, T> Deref for VarModify<'s, 'a, T>

where T: VarValue,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<VarModify<'s, 'a, T> as Deref>::Target

Dereferences the value.

impl<'s, 'a, T> DerefMut for VarModify<'s, 'a, T>

where T: VarValue,

fn deref_mut(&mut self) -> &mut <VarModify<'s, 'a, T> as Deref>::Target

Mutably dereferences the value.