Struct eyeball::ObservableWriteGuard

pub struct ObservableWriteGuard<'a, T: 'a, L: Lock = SyncLock> { /* private fields */ }

A write guard for the inner value of an observable.

Note that as long as an ObservableWriteGuard is kept alive, the associated SharedObservable is locked and can not be updated except through that guard.

Implementations

impl<'a, T: 'a, L: Lock> ObservableWriteGuard<'a, T, L>

pub fn set(this: &mut Self, value: T) -> T

Set the inner value to the given value, notify subscribers and return the previous value.

pub fn set_if_not_eq(this: &mut Self, value: T) -> Option<T>

where T: PartialEq,

Set the inner value to the given value if it doesn’t compare equal to the existing value.

If the inner value is set, subscribers are notified and Some(previous_value) is returned. Otherwise, None is returned.

pub fn set_if_hash_not_eq(this: &mut Self, value: T) -> Option<T>

where T: Hash,

Set the inner value to the given value if it has a different hash than the existing value.

If the inner value is set, subscribers are notified and Some(previous_value) is returned. Otherwise, None is returned.

pub fn take(this: &mut Self) -> T

where T: Default,

Set the inner value to a Default instance of its type, notify subscribers and return the previous value.

Shorthand for ObservableWriteGuard::set(this, T::default()).

pub fn update(this: &mut Self, f: impl FnOnce(&mut T))

Update the inner value and notify subscribers.

Note that even if the inner value is not actually changed by the closure, subscribers will be notified as if it was. Use update_if if you want to conditionally mutate the inner value.

pub fn update_if(this: &mut Self, f: impl FnOnce(&mut T) -> bool)

Maybe update the inner value and notify subscribers if it changed.

The closure given to this function must return true if subscribers should be notified of a change to the inner value.

Trait Implementations

impl<T: Debug> Debug for ObservableWriteGuard<'_, T>

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

Formats the value using the given formatter.

impl<T, L: Lock> Deref for ObservableWriteGuard<'_, T, L>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.