Struct OwnedMutableState 

pub struct OwnedMutableState<T: Clone + 'static> { /* private fields */ }

Owning state handle for reclaimable state cells.

Implementations

impl<T: Clone + 'static> OwnedMutableState<T>

pub fn with_runtime(value: T, runtime: RuntimeHandle) -> Self

Creates a state holding value in runtime. The state is released when the last clone of this handle is dropped. Every write counts as a change, even of an equal value.

pub fn with_runtime_structural_eq(value: T, runtime: RuntimeHandle) -> Self

where T: PartialEq,

Creates a state holding value in runtime. Writing a value equal to the current one is not a change.

pub fn handle(&self) -> MutableState<T>

Returns the copyable MutableState handle. It does not keep the state alive.

pub fn as_state(&self) -> State<T>

Returns a read-only view of the state.

Methods from Deref<Target = MutableState<T>>

pub fn is_alive(&self) -> bool

Returns true while the state exists. It ends when its owner releases it or its runtime is dropped.

pub fn try_with<R>(&self, f: impl FnOnce(&T) -> R) -> Option<R>

Reads the value through f without subscribing the current scope. Returns None if the state was released or has no readable value.

pub fn try_value(&self) -> Option<T>

Returns a copy of the value without subscribing the current scope, or None if the state was released or has no readable value.

pub fn as_state(&self) -> State<T>

Returns a read-only view of this state.

pub fn try_retain(&self) -> Option<OwnedMutableState<T>>

Returns an OwnedMutableState that keeps this state alive until its last clone is dropped. Returns None if the state was already released.

pub fn retain(&self) -> OwnedMutableState<T>

Returns an OwnedMutableState that keeps this state alive until its last clone is dropped. Panics if the state was released.

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Reads a copy of the value through f and subscribes the current scope. f may write this state; see Self::read for a read that borrows instead of copying.

pub fn read<R>(&self, f: impl FnOnce(&T) -> R) -> R

Reads the value in place through f and subscribes the current scope. Nothing is cloned, so a read of a large value costs nothing beyond f; in return f borrows the stored value and must not write this state.

pub fn update<R>(&self, f: impl FnOnce(&mut T) -> R) -> R

Runs f on a copy of the value and stores the copy, unless f wrote this state itself. Scopes that read the state are notified if the value changed.

pub fn replace(&self, value: T)

Stores value and notifies the scopes that read the state, if the state’s equality policy sees a change. Does nothing if the state was released.

pub fn set_value(&self, value: T)

Same as replace.

pub fn set(&self, value: T)

Same as replace.

pub fn value(&self) -> T

Returns a copy of the value and subscribes the current scope, which recomposes when the value changes. Panics if the state was released.

pub fn get(&self) -> T

Same as value.

pub fn get_non_reactive(&self) -> T

Returns a copy of the value without subscribing the current scope.

Trait Implementations

impl<T: Clone + Clone + 'static> Clone for OwnedMutableState<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Clone + 'static> Deref for OwnedMutableState<T>

type Target = MutableState<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Clone + 'static> PartialEq for OwnedMutableState<T>

Two owning handles are equal when they hold the same state, as two MutableState handles are.

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.