Struct zng_var::VarModify

source ·
pub struct VarModify<'a, T: VarValue> { /* private fields */ }
Expand description

Represents the current value in a Var::modify handler.

Implementations§

source§

impl<'a, T: VarValue> VarModify<'a, T>

source

pub fn set(&mut self, new_value: T)

Replace the value.

The variable will update if the new value is not equal to the previous after all modify closures apply.

source

pub fn update(&mut self)

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

source

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

Returns a mutable reference for modification.

Note that this clones the current value if this is the first modify closure requesting it.

The variable will update if the new value is not equal to the previous after all modify closures apply.

source

pub fn tags(&self) -> &[Box<dyn AnyVarValue>]

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.

source

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.

source

pub fn push_tags(&mut self, tags: Vec<Box<dyn AnyVarValue>>)

Add all custom tags.

source

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).

source

pub fn new(current_value: &'a T) -> Self

New from current value.

source

pub fn finish( self, ) -> (bool, Option<T>, bool, Vec<Box<dyn AnyVarValue>>, Option<usize>)

Returns (notify, new_value, update, tags, custom_importance).

Trait Implementations§

source§

impl<'a, T: VarValue> AsRef<T> for VarModify<'a, T>

source§

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<'a, T: VarValue> Deref for VarModify<'a, T>

source§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.

Auto Trait Implementations§

§

impl<'a, T> Freeze for VarModify<'a, T>
where T: Freeze,

§

impl<'a, T> !RefUnwindSafe for VarModify<'a, T>

§

impl<'a, T> Send for VarModify<'a, T>

§

impl<'a, T> Sync for VarModify<'a, T>

§

impl<'a, T> Unpin for VarModify<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for VarModify<'a, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more